rds_instance_info – получение информации об одном или нескольких экземплярах RDS
Новое в версии 2.6.
Обзор
- получение информации об одном или нескольких экземплярах RDS
- Этот модуль назывался
rds_instance_factsдо Ansible 2.9. Использование не изменилось.
Псевдонимы: rds_instance_facts
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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 - | Фильтр, определяющий один или несколько экземпляров БД для описания. См. 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 information about an instance
- rds_instance_info:
db_instance_identifier: new-database
register: new_database_info
# Get all RDS instances
- rds_instance_info:
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | ||||
|---|---|---|---|---|---|---|
| экземпляры сложный | всегда | Список экземпляров RDS | ||||
| размер_выделенного_хранилища целое число | всегда | Гигабайты выделенного хранилища для базы данных Пример: 10 | ||||
| автоматическое_обновление_незначительных_версий булево | всегда | Происходят ли автоматические обновления незначительных версий Пример: True | ||||
| зона_доступности строка | всегда | Зона доступности, в которой находится база данных Пример: us-west-2b | ||||
| период_сохранения_резервных_копий целое число | всегда | Дни, в течение которых сохраняются резервные копии Пример: 7 | ||||
| идентификатор_сертификата_удостоверения_ЦС строка | всегда | Идентификатор сертификата CA Пример: rds-ca-2015 | ||||
| скопировать_метки_в_снимок булево | всегда | Нужно ли копировать метки БД в снимок | ||||
| arn_экземпляра_базы_данных строка | всегда | ARN экземпляра базы данных Пример: arn:aws:rds:us-west-2:111111111111:db:helloworld-rds | ||||
| класс_экземпляра_базы_данных строка | всегда | Класс экземпляра базы данных Пример: db.t2.small | ||||
| идентификатор_экземпляра_базы_данных строка | всегда | Идентификатор экземпляра базы данных Пример: helloworld-rds | ||||
| порт_экземпляра_базы_данных целое число | всегда | Порт, используемый экземпляром базы данных | ||||
| статус_экземпляра_базы_данных строка | всегда | Статус экземпляра базы данных Пример: доступен | ||||
| имя_базы_данных строка | всегда | Имя базы данных Пример: management | ||||
| параметры_группы_базы_данных сложный | всегда | Список групп параметров базы данных | ||||
| имя_группы_параметров_базы_данных строка | всегда | Имя группы параметров базы данных Пример: psql-pg-helloworld | ||||
| статус_применения_параметра строка | всегда | Применена ли группа параметров Пример: в_синхронизации | ||||
| группы_безопасности_базы_данных список | всегда | Список групп безопасности, используемых экземпляром базы данных | ||||
| группа_подсетей_базы_данных сложный | всегда | список групп подсетей | ||||
| описание_группы_подсетей_базы_данных строка | всегда | Описание группы подсетей БД Пример: Моя группа подсетей базы данных | ||||
| имя_группы_подсетей_базы_данных строка | всегда | Имя группы подсетей базы данных Пример: моя-группа-подсетей | ||||
| статус_группы_подсетей строка | всегда | Статус группы подсетей Пример: Завершен | ||||
| подсети сложный | всегда | Список подсетей в группе подсетей | ||||
| зона_доступности_подсети сложный | всегда | Зона доступности подсети | ||||
| имя строка | всегда | Имя зоны доступности Пример: us-west-2c | ||||
| идентификатор_подсети строка | всегда | ID подсети Пример: subnet-abcd1234 | ||||
| статус_подсети строка | всегда | Статус подсети Пример: Активна | ||||
| id_vpc строка | всегда | ID VPC группы подсетей Пример: vpc-abcd1234 | ||||
| идентификатор_ресурса_dbi строка | всегда | Уникальный неизменяемый идентификатор экземпляра БД, уникальный для AWS региона Пример: db-AAAAAAAAAAAAAAAAAAAAAAAAAA | ||||
| членства_в_домене список | всегда | Список членств в домене | ||||
| конечная_точка сложный | всегда | Конечная точка базы данных | ||||
| адрес строка | всегда | Адрес конечной точки базы данных Пример: helloworld-rds.ctrqpe3so1sf.us-west-2.rds.amazonaws.com | ||||
| hosted_zone_id строка | всегда | Идентификатор размещённой зоны Route53 Пример: Z1PABCD0000000 | ||||
| порт целое число | всегда | Порт конечной точки базы данных Пример: 5432 | ||||
| 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 строка | всегда | Идентификатор ключа 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 | ||||
| status строка | всегда | Состояние группы параметров Пример: 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 | ||||
| tags сложная структура | всегда | Теги, используемые экземпляром базы данных | ||||
| vpc_security_groups сложная структура | всегда | Список групп безопасности VPC | ||||
| status строка | всегда | Состояние группы безопасности 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.9/modules/rds_instance_info_module.html
