rds_snapshot_info – получение информации об одном или нескольких снимках RDS
Новая в версии 2.6.
Обзор
- получение информации об одном или нескольких снимках RDS. Это могут быть снимки для несгруппированных снимков или снимки кластеризованных баз данных (Aurora)
- информация о снимках Aurora может быть получена, если не передаются параметры идентификатора или передаются параметры кластера.
- Этот модуль назывался
rds_snapshot_factsдо Ansible 2.9. Использование не изменилось.
Псевдонимы: rds_snapshot_facts
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода общего списка, созданного во время выполнения книги команд. |
| 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 логический тип |
| При значении «нет» сертификаты 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), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONможно использовать для указания AWS-региона, когда это необходимо, но это также можно настроить в конфигурационном файле boto
Примеры
# Get information about an snapshot
- rds_snapshot_info:
db_snapshot_identifier: snapshot_name
register: new_database_info
# Get all RDS snapshots for an RDS instance
- rds_snapshot_info:
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 boolean | always | Включена ли аутентификация базы данных через IAM | |
| instance_create_time string | always | Время создания экземпляра Пример: 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 integer | always | Процент выполнения создания снимка Пример: 100 | |
| snapshot_create_time string | always | Время создания снимка Пример: 2018-05-16T04:03:33.871000+00:00 | |
| snapshot_type string | always | Тип снимка Пример: автоматический | |
| status string | always | Состояние снимка Пример: доступен | |
| storage_type string | always | Тип хранилища подлежащей БД Пример: gp2 | |
| tags complex | always | Теги снимка | |
| vpc_id string | always | Идентификатор 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.9/modules/rds_snapshot_info_module.html
