rds_snapshot_facts - получение фактов об одном или нескольких снимках RDS
Новое в версии 2.6.
Синопсис
- получение фактов об одном или нескольких снимках RDS. Это могут быть снимки для несгруппированных баз данных или снимки кластеризованных баз данных (Aurora)
- факты о снимках Aurora могут быть получены, если не указаны параметры идентификатора или указаны параметры кластера.
Требования
Ниже перечислены требования к хосту, на котором выполняется данный модуль.
- 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_cluster_identifier | Имя кластера RDS, для которого необходимо найти снимки. Взаимоисключительно с параметрами db_snapshot_identifier, db_instance_identifier, db_cluster_snapshot_identifier
| |
| db_cluster_snapshot_identifier | Имя снимка кластера RDS. Взаимоисключительно с параметрами db_instance_identifier, db_snapshot_identifier, db_cluster_identifier
| |
| db_instance_identifier | Имя экземпляра RDS, для которого необходимо найти снимки. Взаимоисключительно с параметрами db_snapshot_identifier, db_cluster_identifier, db_cluster_snapshot_identifier
| |
| db_snapshot_identifier | Имя снимка RDS (несгруппированной базы данных). Взаимоисключительно с параметрами db_instance_identifier, db_cluster_identifier, db_cluster_snapshot_identifier
Псевдонимы: snapshot_name | |
| ec2_url | URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если не используется регион. Если не задан, используется значение переменной окружения EC2_URL, если она задана. | |
| profile (добавлено в 1.6) | Использует профиль boto. Работает только с boto >= 2.24.0. | |
| region | Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она задана. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
Псевдонимы: aws_region, ec2_region | |
| security_token (добавлено в 1.6) | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token | |
| snapshot_type |
| Тип снимка для поиска. По умолчанию возвращаются как автоматические, так и ручные снимки. |
| validate_certs bool (добавлено в 1.5) |
| При установке в "нет", сертификаты SSL для boto версий >= 2.6.0 не будут валидироваться. |
Примечания
Примечание
- Если параметры не установлены в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета
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), если учетные данные не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в конфигурационном файле boto
Примеры
# Get facts about an snapshot
- rds_snapshot_facts:
db_snapshot_identifier: snapshot_name
register: new_database_facts
# Get all RDS snapshots for an RDS instance
- rds_snapshot_facts:
db_instance_identifier: helloworld-rds-master
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| cluster_snapshots сложный тип | всегда | Список снимков кластера | |
| allocated_storage целое число | всегда | Сколько гигабайт памяти выделено Пример: 1 | |
| availability_zones список | всегда | Доступные зоны базы данных, со снимка которой был создан снимок Пример: ['ca-central-1a', 'ca-central-1b'] | |
| cluster_create_time строка | всегда | Дата и время создания кластера Пример: 2018-05-17T00:13:40.223000+00:00 | |
| db_cluster_identifier строка | всегда | Идентификатор кластера базы данных Пример: test-aurora-cluster | |
| db_cluster_snapshot_arn строка | всегда | ARN снимка базы данных Пример: arn:aws:rds:ca-central-1:111111111111:cluster-snapshot:test-aurora-snapshot | |
| db_cluster_snapshot_identifier строка | всегда | Идентификатор снимка Пример: test-aurora-snapshot | |
| engine строка | всегда | Двигатель базы данных Пример: aurora | |
| engine_version строка | всегда | Версия двигателя базы данных Пример: 5.6.10a | |
| iam_database_authentication_enabled логический тип | всегда | Включена ли аутентификация базы данных через IAM | |
| kms_key_id строка | всегда | Идентификатор ключа KMS, шифрующего снимок Пример: arn:aws:kms:ca-central-1:111111111111:key/abcd1234-abcd-1111-aaaa-0123456789ab | |
| license_model строка | всегда | Модель лицензии Пример: aurora | |
| master_username строка | всегда | Имя пользователя мастера базы данных Пример: shertel | |
| percent_progress целое число | всегда | Процент выполнения создания снимка | |
| port целое число | всегда | Порт базы данных | |
| snapshot_create_time строка | всегда | Дата и время создания снимка Пример: 2018-05-17T00:23:23.731000+00:00 | |
| snapshot_type строка | всегда | Тип снимка Пример: manual | |
| status строка | всегда | Статус снимка Пример: creating | |
| storage_encrypted логический тип | всегда | Зашифрован ли снимок Пример: True | |
| tags сложный тип | всегда | Теги снимка | |
| vpc_id строка | всегда | VPC базы данных Пример: vpc-abcd1234 | |
| snapshots сложный тип | Когда параметры кластера не переданы | Список снимков, не относящихся к кластеру | |
| allocated_storage целое число | всегда | Сколько гигабайт памяти выделено Пример: 10 | |
| availability_zone строка | всегда | Доступная зона базы данных, со снимка которой был создан снимок Пример: us-west-2b | |
| db_instance_identifier строка | всегда | Идентификатор экземпляра базы данных Пример: hello-world-rds | |
| db_snapshot_arn строка | всегда | ARN снимка Пример: arn:aws:rds:us-west-2:111111111111:snapshot:rds:hello-world-rds-us1-2018-05-16-04-03 | |
| db_snapshot_identifier строка | всегда | Имя снимка Пример: rds:hello-world-rds-us1-2018-05-16-04-03 | |
| encrypted логический тип | всегда | Был ли снимок зашифрован Пример: True | |
| engine строка | всегда | Двигатель базы данных Пример: postgres | |
| engine_version строка | всегда | Версия двигателя базы данных Пример: 9.5.10 | |
| iam_database_authentication_enabled логический тип | всегда | Включена ли аутентификация базы данных через IAM | |
| instance_create_time строка | всегда | Время создания экземпляра Пример: 2017-10-10T04:00:07.434000+00:00 | |
| kms_key_id string | always | Идентификатор ключа KMS, шифрующего снимок Пример: arn:aws:kms:us-west-2:111111111111:key/abcd1234-1234-aaaa-0000-1234567890ab | |
| license_model string | always | Модель лицензии Пример: postgresql-license | |
| master_username string | always | Имя пользователя базы данных master Пример: dbadmin | |
| option_group_name string | always | Имя группы параметров базы данных Пример: default:postgres-9-5 | |
| percent_progress int | always | Процент выполнения создания снимка Пример: 100 | |
| snapshot_create_time string | always | Время создания снимка Пример: 2018-05-16T04:03:33.871000+00:00 | |
| snapshot_type string | always | Тип снимка Пример: automated | |
| status string | always | Статус снимка Пример: available | |
| storage_type string | always | Тип хранилища подлежащей БД Пример: gp2 | |
| tags complex | always | Теги снимка | |
| vpc_id string | always | Идентификатор VPC, содержащей БД Пример: vpc-abcd1234 |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Дополнительная информация см. в разделе Обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- Will Thames (@willthames)
Подсказка
Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/rds_snapshot_facts_module.html
