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

Примечание

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

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

Для использования в playbook укажите: 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 путь		Расположение файла сертификата CA, используемого для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: Файл сертификата CA считывается со стороны модуля и может потребоваться явно скопировать его с контроллера, если он не запускается локально.
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:action" во время задачи, выводящего набор в ключ task results.resource_actions. Используйте вызов aws_resource_action, чтобы вывести полный список, сделанный во время выполнения playbook. Также может использоваться переменная среды 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	Указывает, должна ли подсеть присутствовать или отсутствовать.
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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/rds_subnet_group_module.html