rds_snapshot – управление моментальными снимками Amazon RDS
Новая в версии 2.9.
Описание
- Создаёт или удаляет моментальные снимки RDS.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- boto
- boto3
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key строка | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key | |
| aws_secret_key строка | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key | |
| db_instance_identifier строка | Идентификатор экземпляра базы данных. Требуется, если задано состояние. Псевдонимы: instance_id | |
| db_snapshot_identifier строка / обязательно | Моментальный снимок для управления. Псевдонимы: id, snapshot_id | |
| debug_botocore_endpoint_logs логический тип добавлен в 2.8 |
| Используйте регистрирователь botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие» во время задачи, выводия набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, сделанного во время выполнения плейбука. Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| ec2_url строка | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если таковое имеется. | |
| profile строка | Использует профиль boto. Работает только с boto >= 2.24.0. | |
| 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. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token | |
| state строка |
| Укажите желаемое состояние моментального снимка. |
| tags словарь | словарь тегов для применения к моментальному снимку. | |
| validate_certs логический тип |
| Если установлено в «нет», сертификаты SSL не будут проверены для версий boto >= 2.6.0. |
| wait логический тип |
| Дожидаться или нет создания или удаления моментального снимка. |
| wait_timeout целое число | Значение по умолчанию: 300 | время ожидания, прежде чем ожидание сдастся, в секундах. |
Примечания
Примечание
- Если параметры не установлены в рамках модуля, следующие переменные окружения могут использоваться в порядке убывания приоритета
AWS_URLилиEC2_URL,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 - Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно используются для указания AWS региона, когда это необходимо, но это также можно настроить в файле конфигурации boto
Примеры
# Create snapshot
- rds_snapshot:
db_instance_identifier: new-database
db_snapshot_identifier: new-database-snapshot
# Delete snapshot
- 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 |
Состояние
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Will Thames (@willthames)
- Michael De La Rue (@mikedlr)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/rds_snapshot_module.html
