community.aws.rds_subnet_group – управление подсетями групп баз данных RDS

Примечание

Этот плагин входит в состав коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в книге задач, укажите: community.aws.rds_subnet_group.

Новое в версии 1.0.0: коллекции community.aws

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

Обзор

Создаёт, изменяет и удаляет подсети групп баз данных RDS. Данный модуль зависит от python-boto >= 2.5.

Требования

Ниже перечислены требования к хосту, на котором будет выполняться данный модуль.

python >= 2.6
boto

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key строка		Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_access_key и profile устарело и будет сделано взаимоисключающими после 2022-06-01. псевдонимы: ec2_access_key, access_key
aws_ca_bundle путь		Расположение файла с корневым сертификатом для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: Файл с корневым сертификатом читается на стороне модуля и может потребоваться явное копирование с контроллера, если выполнение не происходит локально.
aws_config словарь		Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. Дополнительную информацию о конфигурации boto см. в http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto.
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_secret_key и profile устарело и будет сделано взаимоисключающими после 2022-06-01. псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs логический	Варианты: нет ← да	Использует логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», производимых во время выполнения задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, выполненного во время выполнения книги задач. Также может быть использована переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
description строка		Описание подсети группы базы данных. Требуется при state=present.
ec2_url строка		URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует адреса EC2). Игнорируется для модулей, где регион обязателен. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если таковая есть. псевдонимы: aws_endpoint_url, endpoint_url
name строка / обязательно		Идентификатор подсети группы базы данных.
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределяет aws_access_key, aws_secret_key и security_token, а поддержка одновременного их использования с profile устарела. aws_access_key, aws_secret_key и security_token будут сделаны взаимоисключающими с profile после 2022-06-01. псевдонимы: aws_profile
region строка		AWS-регион. Если не задан, используется значение переменной среды AWS_REGION или EC2_REGION, если таковая есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region псевдонимы: aws_region, ec2_region
security_token строка		Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров security_token и profile устарело и будет сделано взаимоисключающими после 2022-06-01. псевдонимы: aws_security_token, access_token
state строка / обязательно	Варианты: present absent	Указывает, должна ли подсеть быть present или absent.
subnets список / элементы=строка		Список идентификаторов подсетей, составляющих группу подсетей базы данных. Требуется при state=present.
validate_certs логический	Варианты: нет да ←	При значении «нет» SSL-сертификаты для boto-версий >= 2.6.0 не будут проверяться.

Примечания

Примечание

Если параметры не заданы в модуле, могут быть использованы следующие переменные среды в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY или EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY или EC2_SECRET_KEY, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN, AWS_REGION или EC2_REGION, AWS_CA_BUNDLE
Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не указаны. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION обычно используются для указания AWS-региона, когда это необходимо, но также может быть настроено в файле конфигурации boto

Примеры

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

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

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

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

Ключ		Возвращаемое значение	Описание
subnet_group сложный		state=present	Словарь значений DB-группы подсетей
	db_subnet_group_arn строка	state=present	ARN DB-группы подсетей
	db_subnet_group_description строка	state=present	Описание DB-группы подсетей
	db_subnet_group_name строка	state=present	Имя DB-группы подсетей
	description строка	state=present	Описание DB-группы подсетей (сохраняется для обратной совместимости)
	name строка	state=present	Имя DB-группы подсетей (сохраняется для обратной совместимости)
	status строка	state=present	Статус DB-группы подсетей (сохраняется для обратной совместимости)
	subnet_group_status строка	state=present	Статус DB-группы подсетей
	subnet_ids список / элементы=строка	state=present	Содержит список идентификаторов подсетей
	subnets список / элементы=строка	state=present	Содержит список элементов подсетей (@см. https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/rds.html#RDS.Client.describe_db_subnet_groups)
	vpc_id строка	state=present	VpcId DB-группы подсетей

Авторы

Scott Anderson (@tastychutney)

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