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 boolean добавлено в 1.5 |
| Если установлено "no", сертификаты 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 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 | ID ключа KMS, шифрующего снимок Пример: arn:aws:kms:us-west-2:111111111111:key/abcd1234-1234-aaaa-0000-1234567890ab | |
| license_model string | always | Модель лицензии Пример: postgresql-license | |
| master_username string | always | Имя пользователя базы данных (мастер) Пример: 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 | Тип снимка Пример: automated | |
| status string | always | Статус снимка Пример: available | |
| storage_type string | always | Тип хранилища подлежащей базы данных Пример: gp2 | |
| tags complex | always | Теги снимка | |
| vpc_id string | always | ID VPC, содержащей базу данных Пример: vpc-abcd1234 |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом 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.7/modules/rds_snapshot_facts_module.html
