rds_instance_facts – получение фактов об одном или нескольких экземплярах RDS
Новое в версии 2.6.
Описание
- получение фактов об одном или нескольких экземплярах RDS
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- boto
- boto3
- python >= 2.6
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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 - | Уникальный идентификатор экземпляра RDS. псевдонимы: id | |
| debug_botocore_endpoint_logs логическое значение добавлено в 2.8 |
| Используйте логгер botocore.endpoint для разбора уникальных (а не общих) API-вызовов "ресурс:действие", которые выполняются во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action, чтобы вывести в общий список, созданный во время выполнения игры. |
| ec2_url строка | URL для подключения к облаку EC2 или Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не указан, используется значение переменной окружения EC2_URL, если она есть. | |
| filters - | Фильтр, определяющий один или несколько экземпляров DB для описания. См. https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html
| |
| 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 | |
| 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 facts about an instance
- rds_instance_facts:
db_instance_identifier: new-database
register: new_database_facts
# Get all RDS instances
- rds_instance_facts:
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||||
|---|---|---|---|---|---|---|
| instances сложный | всегда | Список экземпляров RDS | ||||
| allocated_storage целое число | всегда | Гигабайты выделенного хранилища для базы данных Пример: 10 | ||||
| auto_minor_version_upgrade булево | всегда | Автоматически ли происходят обновления незначительных версий Пример: True | ||||
| availability_zone строка | всегда | Зона доступности, в которой расположена база данных Пример: us-west-2b | ||||
| backup_retention_period целое число | всегда | Количество дней, в течение которых сохраняются резервные копии Пример: 7 | ||||
| ca_certificate_identifier строка | всегда | Идентификатор сертификата CA Пример: rds-ca-2015 | ||||
| copy_tags_to_snapshot булево | всегда | Нужно ли копировать теги БД в снимок | ||||
| db_instance_arn строка | всегда | ARN экземпляра базы данных Пример: arn:aws:rds:us-west-2:111111111111:db:helloworld-rds | ||||
| db_instance_class строка | всегда | Класс экземпляра базы данных Пример: db.t2.small | ||||
| db_instance_identifier строка | всегда | Идентификатор экземпляра базы данных Пример: helloworld-rds | ||||
| db_instance_port целое число | всегда | Порт, используемый экземпляром базы данных | ||||
| db_instance_status строка | всегда | Статус экземпляра базы данных Пример: available | ||||
| db_name строка | всегда | Имя базы данных Пример: management | ||||
| db_parameter_groups сложный | всегда | Список групп параметров базы данных | ||||
| db_parameter_group_name строка | всегда | Имя группы параметров базы данных Пример: psql-pg-helloworld | ||||
| parameter_apply_status строка | всегда | Применена ли группа параметров Пример: in-sync | ||||
| db_security_groups список | всегда | Список групп безопасности, используемых экземпляром базы данных | ||||
| db_subnet_group сложный | всегда | список подсетей | ||||
| db_subnet_group_description строка | всегда | Описание группы подсетей БД Пример: Моя группа подсетей базы данных | ||||
| db_subnet_group_name строка | всегда | Имя группы подсетей базы данных Пример: my-subnet-group | ||||
| subnet_group_status строка | всегда | Статус группы подсетей Пример: Complete | ||||
| subnets сложный | всегда | Список подсетей в группе подсетей | ||||
| subnet_availability_zone сложный | всегда | Зона доступности подсети | ||||
| name строка | всегда | Название зоны доступности Пример: us-west-2c | ||||
| subnet_identifier строка | всегда | ID подсети Пример: subnet-abcd1234 | ||||
| subnet_status строка | всегда | Статус подсети Пример: Active | ||||
| vpc_id строка | всегда | ID VPC группы подсетей Пример: vpc-abcd1234 | ||||
| dbi_resource_id строка | всегда | Уникальный, неизменяемый идентификатор экземпляра базы данных в AWS-регионе Пример: db-AAAAAAAAAAAAAAAAAAAAAAAAAA | ||||
| domain_memberships список | всегда | Список членств в домене | ||||
| endpoint сложный | всегда | Точка входа в базу данных | ||||
| address строка | всегда | Адрес точки входа в базу данных Пример: helloworld-rds.ctrqpe3so1sf.us-west-2.rds.amazonaws.com | ||||
| hosted_zone_id строка | всегда | ID выделенной зоны Route53 Пример: Z1PABCD0000000 | ||||
| порт целое число | всегда | Порт конечной точки базы данных Пример: 5432 | ||||
| движок строка | всегда | Движок базы данных Пример: postgres | ||||
| версия_движка строка | всегда | Версия движка базы данных Пример: 9.5.10 | ||||
| iam_database_authentication_enabled булево | всегда | Включена ли аутентификация базы данных через IAM | ||||
| время_создания_экземпляра строка | всегда | Дата и время создания экземпляра Пример: 2017-10-10T04:00:07.434000+00:00 | ||||
| kms_key_id строка | всегда | Идентификатор ключа KMS Пример: arn:aws:kms:us-west-2:111111111111:key/abcd1234-0000-abcd-1111-0123456789ab | ||||
| latest_restorable_time строка | всегда | Последнее время, до которого можно восстановить базу данных с помощью восстановления по состоянию на определенный момент времени Пример: 2018-05-17T00:03:56+00:00 | ||||
| license_model строка | всегда | Модель лицензии Пример: postgresql-license | ||||
| master_username строка | всегда | Имя пользователя базы данных мастера Пример: dbadmin | ||||
| monitoring_interval целое число | всегда | Интервал в секундах между точками, когда для экземпляра базы данных собираются метрики усовершенствованного мониторинга | ||||
| multi_az булево | всегда | Включен ли Multi-AZ | ||||
| option_group_memberships сложное | всегда | Список групп параметров | ||||
| option_group_name строка | всегда | Имя группы параметров Пример: default:postgres-9-5 | ||||
| статус строка | всегда | Статус группы параметров Пример: in-sync | ||||
| pending_modified_values сложное | всегда | Ожидаемые значения, требующие применения | ||||
| performance_insights_enabled булево | всегда | Включены ли аналитические данные о производительности | ||||
| preferred_backup_window строка | всегда | Предпочтительное время резервного копирования Пример: 04:00-05:00 | ||||
| preferred_maintenance_window строка | всегда | Предпочтительное окно технического обслуживания Пример: mon:05:00-mon:05:30 | ||||
| publicly_accessible булево | всегда | Доступна ли база данных для общего доступа | ||||
| read_replica_db_instance_identifiers список | всегда | Список идентификаторов экземпляров базы данных с чтением реплики | ||||
| storage_encrypted булево | всегда | Зашифрован ли хранилище Пример: True | ||||
| storage_type строка | всегда | Тип хранилища экземпляра базы данных Пример: gp2 | ||||
| метки сложное | всегда | Метки, используемые экземпляром базы данных | ||||
| vpc_security_groups сложное | всегда | Список групп безопасности VPC | ||||
| статус строка | всегда | Статус группы безопасности VPC Пример: active | ||||
| vpc_security_group_id строка | всегда | Идентификатор группы безопасности VPC Пример: sg-abcd1234 | ||||
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.8/modules/rds_instance_facts_module.html
