Модуль amazon.aws.rds_subnet_group — управление группами подсетей баз данных RDS

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: amazon.aws.rds_subnet_group.

Добавлено в amazon.aws 5.0.0

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Создаёт, изменяет и удаляет группы подсетей баз данных RDS.
Этот модуль был впервые добавлен в community.aws в выпуске 1.0.0.

Требования

Следующие требования должны быть выполнены на узле, на котором выполняется этот модуль.

python >= 3.6
boto3 >= 1.35.0
botocore >= 1.35.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key строка	Идентификатор ключа доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные окружения `AWS_ACCESS_KEY_ID` или `AWS_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для единообразия с AWS botocore SDK.
aws_ca_bundle путь	Путь к набору сертификатов центра сертификации, используемому для проверки SSL-сертификатов. Также можно использовать переменную окружения `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs логическое значение	Использовать регистратор `botocore.endpoint` для анализа уникальных (а не общего количества) вызовов API `"resource:action"`, выполняемых во время задачи, и выводить их список в ключ resource_actions результатов задачи. Используйте callback `aws_resource_action`, чтобы вывести общий список вызовов, выполненных в ходе плейбука. Также можно использовать переменную окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
description строка	Описание группы подсетей базы данных. Обязателен, если задано state=present.
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную окружения `AWS_URL`.
name строка / обязательный	Идентификатор группы подсетей базы данных.
profile псевдонимы: aws_profile строка	Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную окружения `AWS_PROFILE`. Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token.
purge_tags логическое значение	Если установлено значение `purge_tags=true` и задан параметр `tags`, существующие теги ресурса будут удалены, чтобы его набор тегов точно соответствовал указанному в параметре `tags`. Если параметр `tags` не задан, теги не изменяются, даже если `purge_tags=True`. Ключи тегов, начинающиеся с `aws:`, зарезервированы Amazon и не могут быть изменены. Поэтому при обработке параметра `purge_tags` они игнорируются. Дополнительные сведения см. в документации Amazon: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions. Варианты: `false` `true` ← (по умолчанию)
region псевдонимы: aws_region строка	Регион AWS, который необходимо использовать. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную окружения `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key строка	Секретный ключ доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные окружения `AWS_SECRET_ACCESS_KEY` или `AWS_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для единообразия с AWS botocore SDK.
session_token псевдонимы: aws_session_token строка	Токен сеанса AWS STS для использования с временными учётными данными. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную окружения `AWS_SESSION_TOKEN`. Параметры session_token и profile являются взаимоисключающими.
state строка / обязательный	Указывает, должна ли подсеть существовать или отсутствовать. Варианты: `"present"` `"absent"`
subnets список / элементы=строка	Список идентификаторов подсетей, входящих в группу подсетей базы данных. Обязателен, если задано `state=present`.
tags псевдонимы: resource_tags словарь	Словарь тегов, которые необходимо применить к ресурсу. Если параметр `tags` не задан, теги не изменяются.
validate_certs логическое значение	Если установлено значение `false`, SSL-сертификаты при взаимодействии с API AWS не проверяются. Настоятельно не рекомендуется устанавливать validate_certs=false; вместо этого рассмотрите возможность задать параметр aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Поддержка tags и purge_tags добавлена в выпуске 3.2.0.
Внимание: Для модулей переменные окружения и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для плагинов поиска и подключения переменные окружения и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
Используемый Ansible пакет AWS SDK (boto3) также может считывать значения учётных данных и других параметров по умолчанию, например региона, из файлов конфигурации в контексте «узла» Ansible (обычно ~/.aws/credentials). Дополнительные сведения см. здесь: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

- name: Add or change a subnet group
  amazon.aws.rds_subnet_group:
    state: present
    name: norwegian-blue
    description: My Fancy Ex Parrot Subnet Group
    subnets:
      - subnet-aaaaaaaa
      - subnet-bbbbbbbb

- name: Add or change a subnet group and associate tags
  amazon.aws.rds_subnet_group:
    state: present
    name: norwegian-blue
    description: My Fancy Ex Parrot Subnet Group
    subnets:
      - subnet-aaaaaaaa
      - subnet-bbbbbbbb
    tags:
      tag1: Tag1
      tag2: Tag2

- name: Remove a subnet group
  amazon.aws.rds_subnet_group:
    state: absent
    name: norwegian-blue

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
changed логическое значение	Значение True, если получение списка групп подсетей RDS выполнено успешно. Возвращается: всегда Пример: `false`
subnet_group составной тип	Словарь со свойствами группы подсетей БД. Возвращается: `state=present`
db_subnet_group_arn строка	ARN группы подсетей БД. Возвращается: `state=present` Пример: `"arn:aws:rds:eu-north-1:123456789012:subgrp:ansible-test-13950442"`
db_subnet_group_description строка	Описание группы подсетей БД. Возвращается: `state=present` Пример: `"Simple description."`
db_subnet_group_name строка	Название группы подсетей БД. Возвращается: `state=present` Пример: `"ansible-test-mbp-13950442"`
description строка	Описание группы подсетей БД (сохранено для обратной совместимости). Возвращается: `state=present` Пример: `"Simple description."`
name строка	Название группы подсетей БД (сохранено для обратной совместимости). Возвращается: `state=present` Пример: `"ansible-test-mbp-13950442"`
status строка	Статус группы подсетей БД (сохранён для обратной совместимости). Возвращается: `state=present` Пример: `"Complete"`
subnet_group_status строка	Статус группы подсетей БД. Возвращается: `state=present` Пример: `"Complete"`
subnet_ids список / элементы=строка	Содержит список идентификаторов подсетей. Возвращается: `state=present` Пример: `["subnet-08c94870f4480797e"]`
subnets список / элементы=строка	Содержит список элементов подсетей (см. https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/rds.html#RDS.Client.describe_db_subnet_groups). Возвращается: `state=present`
subnet_availability_zone словарь добавлено в community.aws 3.2.0	Содержит сведения о зоне доступности. Возвращается: `state=present` Пример: `{"name": "eu-north-1b"}`
subnet_identifier строка добавлено в community.aws 3.2.0	Идентификатор подсети. Возвращается: `state=present` Пример: `"subnet-08c94870f4480797e"`
subnet_outpost словарь добавлено в community.aws 3.2.0	Это значение указывает Outpost. Возвращается: `state=present` Пример: `{}`
subnet_status строка добавлено в community.aws 3.2.0	Статус подсети. Возвращается: `state=present` Пример: `"Active"`
tags словарь добавлено в community.aws 3.2.0	Теги, связанные с группой подсетей. Возвращается: `state=present` Пример: `{"tag1": "Tag1", "tag2": "Tag2"}`
vpc_id строка	Идентификатор VPC группы подсетей БД. Возвращается: `state=present` Пример: `"vpc-0acb0ba033ff2119c"`

Авторы

Scott Anderson (@tastychutney)
Alina Buzachis (@alinabuzachis)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/rds_subnet_group_module.html