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
ec2_url		URL для подключения к облаку EC2 или Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если не используется регион. Если не задан, используется значение переменной среды EC2_URL, если таковое есть.
filters		Фильтр, определяющий один или несколько экземпляров DB для описания. См. https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html
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
validate_certs bool (добавлено в 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), если данные аутентификации не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION обычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в конфигурационном файле boto

Примеры

# Get facts about an instance
- rds_instance_facts:
    name: new-database
  register: new_database_facts

# Get all RDS instances
- rds_instance_facts:

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:

Ключ					Возвращаемое значение	Описание
instances complex					всегда	Список экземпляров RDS
	allocated_storage int				всегда	Гигабайты выделенного хранилища для базы данных Пример: 10
	auto_minor_version_upgrade bool				всегда	Автоматически ли выполняются обновления до минорных версий Пример: True
	availability_zone string				всегда	Зона доступности, в которой расположена база данных Пример: us-west-2b
	backup_retention_period int				всегда	Количество дней, в течение которых хранятся резервные копии Пример: 7
	ca_certificate_identifier string				всегда	Идентификатор сертификата УЦ Пример: rds-ca-2015
	copy_tags_to_snapshot bool				всегда	Нужно ли копировать теги БД в снимок
	db_instance_arn string				всегда	ARN экземпляра базы данных Пример: arn:aws:rds:us-west-2:111111111111:db:helloworld-rds
	db_instance_class string				всегда	Класс экземпляра базы данных Пример: db.t2.small
	db_instance_identifier string				всегда	Идентификатор экземпляра базы данных Пример: helloworld-rds
	db_instance_port int				всегда	Порт, используемый экземпляром базы данных
	db_instance_status string				всегда	Статус экземпляра базы данных Пример: available
	db_name string				всегда	Имя базы данных Пример: management
	db_parameter_groups complex				всегда	Список групп параметров базы данных
		db_parameter_group_name string			всегда	Имя группы параметров базы данных Пример: psql-pg-helloworld
		parameter_apply_status string			всегда	Применена ли группа параметров Пример: in-sync
	db_security_groups list				всегда	Список групп безопасности, используемых экземпляром базы данных
	db_subnet_group complex				всегда	Список подсетей групп
		db_subnet_group_description string			всегда	Описание группы подсетей БД Пример: Моя группа подсетей БД
		db_subnet_group_name string			всегда	Имя группы подсетей базы данных Пример: my-subnet-group
		subnet_group_status string			всегда	Статус группы подсетей Пример: Завершено
		subnets complex			всегда	Список подсетей в группе подсетей
			subnet_availability_zone complex		всегда	Зона доступности подсети
				name string	всегда	Название зоны доступности Пример: us-west-2c
			subnet_identifier string		всегда	ID подсети Пример: subnet-abcd1234
			subnet_status string		всегда	Статус подсети Пример: Активная
		vpc_id string			всегда	ID VPC группы подсетей Пример: vpc-abcd1234
	dbi_resource_id string				всегда	Уникальный, неизменяемый идентификатор экземпляра БД в AWS регионе Пример: db-AAAAAAAAAAAAAAAAAAAAAAAAAA
	domain_memberships list				всегда	Список членств в домене
	endpoint complex				всегда	Точка входа базы данных
		address string			всегда	Адрес точки входа базы данных Пример: helloworld-rds.ctrqpe3so1sf.us-west-2.rds.amazonaws.com
		hosted_zone_id string			всегда	ID размещенной зоны Route53 Пример: Z1PABCD0000000

	порт int	всегда	Порт конечной точки базы данных Пример: 5432
движок строка		всегда	Двигатель базы данных Пример: postgres
версия_движка строка		всегда	Версия движка базы данных Пример: 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 int		всегда	Интервал в секундах между точками, когда метрики расширенного мониторинга собираются для экземпляра БД
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 Пример: активный
	vpc_security_group_id строка	всегда	Идентификатор группы безопасности VPC Пример: sg-abcd1234

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. Поддержка и техническое обслуживание модулей.

Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.

Автор

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.6/modules/rds_instance_facts_module.html