community.aws.rds_snapshot – управление снимками Amazon RDS.

Примечание

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

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

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

Добавлена в версии 1.0.0: of community.aws

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

Обзор

Создаёт или удаляет снимки RDS.

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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
db_instance_identifier строка		Идентификатор экземпляра базы данных. Требуется, когда задан параметр state. псевдонимы: instance_id
db_snapshot_identifier строка / обязательно		Снимок для управления. псевдонимы: id, snapshot_id
debug_botocore_endpoint_logs логический тип	Варианты: нет ← да	Использовать логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», сделанных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, сделанный во время книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, для которых требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется. псевдонимы: aws_endpoint_url, endpoint_url
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
purge_tags логический тип	Варианты: нет да ←	удалить теги, отсутствующие в параметре `tags`.
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 security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров security_token и profile устарело и будет исключено после 2022-06-01. псевдонимы: aws_security_token, access_token
state строка	Варианты: present ← absent	Указывает желаемое состояние снимка.
tags словарь		словарь тегов для применения к снимку.
validate_certs логический тип	Варианты: нет да ←	Если установлено в "нет", SSL-сертификаты не будут проверены для версий boto >= 2.6.0.
wait логический тип	Варианты: нет ← да	Ожидать создание или удаление снимка.
wait_timeout целое число	По умолчанию: 300	Время ожидания перед завершением ожидания, в секундах.

Примечания

Примечание

Если параметры не заданы в модуле, могут использоваться следующие переменные среды в порядке убывания приоритета 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: Create snapshot
  community.aws.rds_snapshot:
    db_instance_identifier: new-database
    db_snapshot_identifier: new-database-snapshot

- name: Delete snapshot
  community.aws.rds_snapshot:
    db_snapshot_identifier: new-database-snapshot
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
allocated_storage целое число	всегда	Сколько памяти выделено в ГБ. Пример: 20
availability_zone строка	всегда	Зона доступности базы данных, из которой был создан снимок. Пример: us-west-2a
db_instance_identifier строка	всегда	База данных, из которой был создан снимок. Пример: ansible-test-16638696
db_snapshot_arn строка	всегда	Идентификатор Amazon Resource Name снимка. Пример: arn:aws:rds:us-west-2:123456789012:snapshot:ansible-test-16638696-test-snapshot
db_snapshot_identifier строка	всегда	Имя снимка. Пример: ansible-test-16638696-test-snapshot
dbi_resource_id строка	всегда	Идентификатор исходной БД, который нельзя изменить и который уникален для региона AWS. Пример: db-MM4P2U35RQRAMWD3QDOXWPZP4U
encrypted булево	всегда	Зашифрован ли снимок.
engine строка	всегда	Двигатель базы данных, из которой был создан снимок. Пример: mariadb
engine_version строка	всегда	Версия базы данных, из которой был создан снимок. Пример: 10.2.21
iam_database_authentication_enabled булево	всегда	Включена ли аутентификация базы данных IAM.
instance_create_time строка	всегда	Время создания экземпляра, из которого был создан снимок. Пример: 2019-06-15T10:15:56.221000+00:00
license_model строка	всегда	Модель лицензии базы данных. Пример: general-public-license
master_username строка	всегда	Имя пользователя мастера базы данных. Пример: test
option_group_name строка	всегда	Группа параметров базы данных. Пример: default:mariadb-10-2
percent_progress целое число	всегда	Прогресс создания снимка. Будет 100 для доступного снимка. Пример: 100
port целое число	всегда	Порт, на котором прослушивает база данных. Пример: 3306
processor_features список / элементы=строка	всегда	Список функций процессора базы данных.
snapshot_create_time строка	всегда	Время создания снимка. Пример: 2019-06-15T10:46:23.776000+00:00
snapshot_type строка	всегда	Способ создания снимка (в этом модуле всегда ручное!). Пример: manual
status строка	всегда	Статус снимка. Пример: available
storage_type строка	всегда	Тип хранилища базы данных. Пример: gp2
tags сложное	всегда	Теги, примененные к снимку.
vpc_id строка	всегда	Идентификатор VPC, в котором находится БД. Пример: vpc-09ff232e222710ae0

Авторы

Will Thames (@willthames)
Michael De La Rue (@mikedlr)

© 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_snapshot_module.html