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 | |
| debug_botocore_endpoint_logs логический тип добавлено в 2.8 |
| Используйте логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов «resource:action» во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action, чтобы вывести в общий список, созданный во время выполнения playbook. |
| ec2_url строка | URL-адрес для подключения к EC2 или вашей облачной системе Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если не используется регион. Если не указан, используется значение переменной среды EC2_URL, если она задана. | |
| profile строка | Использует профиль 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 строка | AWS STS security token. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | |
| snapshot_type - |
| Тип снимка для поиска. По умолчанию будут возвращены как автоматические, так и ручные снимки. |
| validate_certs логический тип |
| Если установлено значение «нет», для версий boto >= 2.6.0 сертификаты SSL не будут проверяться. |
Примечания
Примечание
- Если параметры не заданы в модуле, могут быть использованы следующие переменные среды в порядке убывания приоритета
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
Примеры
# 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 строка | всегда | ID ключа KMS, шифрующего снимок Пример: arn:aws:kms:us-west-2:111111111111:key/abcd1234-1234-aaaa-0000-1234567890ab | |
| license_model строка | всегда | Модель лицензии Пример: postgresql-license | |
| master_username строка | всегда | Имя пользователя мастера базы данных Пример: dbadmin | |
| option_group_name строка | всегда | Имя группы параметров базы данных Пример: default:postgres-9-5 | |
| percent_progress целое число | всегда | Процент завершения создания снимка Пример: 100 | |
| snapshot_create_time строка | всегда | Время создания снимка Пример: 2018-05-16T04:03:33.871000+00:00 | |
| snapshot_type строка | всегда | Тип снимка Пример: автоматический | |
| status строка | всегда | Состояние снимка Пример: доступен | |
| storage_type строка | всегда | Тип хранилища основной БД Пример: gp2 | |
| tags сложный | всегда | Теги снимка | |
| vpc_id строка | всегда | ID VPC, содержащей БД Пример: vpc-abcd1234 |
Состояние
- Данный модуль не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.8/modules/rds_snapshot_facts_module.html
