Модуль amazon.aws.rds_instance_info — получение информации об одном или нескольких экземплярах RDS
Примечание
Этот модуль является частью коллекции amazon.aws (версия 8.2.1).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для её установки используйте: ansible-galaxy collection install amazon.aws. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для получения подробностей.
Для использования в плейбуке укажите: amazon.aws.rds_instance_info.
Новая функция в amazon.aws 5.0.0
Обзор
- Получение информации об одном или нескольких экземплярах RDS.
- Этот модуль был первоначально добавлен в
community.awsв релизе 1.0.0.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 3.6
- boto3 >= 1.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка | Идентификатор ключа доступа AWS. Дополнительную информацию об маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут быть использованы переменные среды Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для обеспечения согласованности с SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
aws_ca_bundle путь | Путь к файлу с сертификатом CA для проверки SSL-сертификатов. Также может быть использована переменная среды |
aws_config словарь | Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
db_instance_identifier псевдонимы: id строка | Уникальный идентификатор экземпляра RDS. |
debug_botocore_endpoint_logs логический | Используйте логгер Также может быть использована переменная среды Варианты:
|
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка | URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws протестированы только для AWS. Также могут быть использованы переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
filters словарь | Фильтр, который определяет один или несколько экземпляров баз данных для описания. См. https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html |
profile псевдонимы: aws_profile строка | Используемый профиль AWS для аутентификации. Дополнительную информацию о профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также может быть использована переменная среды Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token. |
region псевдонимы: aws_region, ec2_region строка | Регион AWS для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, region игнорируется. Также могут быть использованы переменные среды См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной среды |
secret_key псевдонимы: aws_secret_access_key, aws_secret_key, ec2_secret_key строка | Секретный ключ доступа AWS. Дополнительную информацию об маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут быть использованы переменные среды Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для обеспечения согласованности с SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string | Токен сессии AWS STS для использования с временными учетными данными. См. документацию AWS для получения дополнительной информации об access-токен https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут использоваться переменные среды Параметры security_token и profile взаимоисключающие. Алиасы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0. Алиасы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды |
validate_certs boolean | При установке в значение Настройка validate_certs=false крайне не рекомендуется, вместо этого рассмотрите возможность установки aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не «контроллер». Поэтому файлы могут потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не «хост».
- AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (обычно
~/.aws/credentials). См. https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html для получения дополнительной информации.
Примеры
- name: Get information about an instance
amazon.aws.rds_instance_info:
db_instance_identifier: new-database
register: new_database_info
- name: Get all RDS instances
amazon.aws.rds_instance_info:
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
instances complex | Список экземпляров RDS Возвращается: всегда |
|
allocated_storage integer |
Гигабайты памяти, выделенные для базы данных. Возвращается: всегда Пример: |
|
auto_minor_version_upgrade boolean |
Производятся ли обновления до младших версий автоматически. Возвращается: всегда Пример: |
|
availability_zone string |
Зона доступности, в которой находится база данных. Возвращается: всегда Пример: |
|
backup_retention_period integer |
Количество дней, в течение которых хранятся резервные копии. Возвращается: всегда Пример: |
|
ca_certificate_identifier string |
Идентификатор сертификата CA. Возвращается: всегда Пример: |
|
copy_tags_to_snapshot boolean |
Следует ли копировать теги БД в снимок. Возвращается: всегда Пример: |
|
db_instance_arn string |
ARN экземпляра базы данных. Возвращается: всегда Пример: |
|
db_instance_class string |
Класс экземпляра базы данных. Возвращается: всегда Пример: |
|
db_instance_identifier string |
Идентификатор экземпляра базы данных. Возвращается: всегда Пример: |
|
db_instance_port integer |
Порт, используемый экземпляром базы данных. Возвращается: всегда Пример: |
|
db_instance_status string |
Статус экземпляра базы данных. Возвращается: всегда Пример: |
|
db_name string |
Имя базы данных. Возвращается: всегда Пример: |
|
db_parameter_groups complex |
Список групп параметров базы данных. Возвращается: всегда |
|
db_parameter_group_name string |
Имя группы параметров базы данных. Возвращается: всегда Пример: |
|
parameter_apply_status string |
Была ли применена группа параметров. Возвращается: всегда Пример: |
|
db_security_groups list / elements=string |
Список групп безопасности, используемых экземпляром базы данных. Возвращается: всегда Пример: |
|
db_subnet_group complex |
Список групп подсетей. Возвращается: всегда |
|
db_subnet_group_description string |
Описание группы подсетей DB. Возвращается: всегда Пример: |
|
db_subnet_group_name string |
Имя группы подсетей базы данных. Возвращается: всегда Пример: |
|
subnet_group_status string |
Статус группы подсетей. Возвращается: всегда Пример: |
|
subnets complex |
Список подсетей в группе подсетей. Возвращается: всегда |
|
subnet_availability_zone complex |
Зона доступности подсети. Возвращается: всегда |
|
name string |
Имя зоны доступности. Возвращается: всегда Пример: |
|
subnet_identifier string |
ID подсети. Возвращается: всегда Пример: |
|
subnet_status string |
Статус подсети. Возвращается: всегда Пример: |
|
vpc_id string |
ID VPC группы подсетей. Возвращается: всегда Пример: |
|
dbi_resource_id string |
Уникальный для региона AWS, неизменяемый идентификатор экземпляра DB. Возвращается: всегда Пример: |
|
deletion_protection boolean added in community.aws 3.3.0 |
Возвращается: всегда Пример: |
|
domain_memberships list / elements=string |
Список членств в домене. Возвращается: всегда Пример: |
|
endpoint complex |
Конечная точка базы данных Возвращается: всегда |
|
address string |
Адрес конечной точки базы данных. Возвращается: всегда Пример: |
|
hosted_zone_id string |
ID хостинговой зоны Route 53. Возвращается: всегда Пример: |
|
port integer |
Порт конечной точки базы данных. Возвращается: всегда Пример: |
|
engine string |
Движок базы данных. Возвращается: всегда Пример: |
|
engine_version string |
Версия базы данных. Возвращается: всегда Пример: |
|
iam_database_authentication_enabled boolean |
Включена ли аутентификация базы данных через IAM. Возвращается: всегда Пример: |
|
instance_create_time string |
Дата и время создания экземпляра. Возвращается: всегда Пример: |
|
iops integer |
Зарезервированное значение IOPS для экземпляра DB. Возвращается: всегда Пример: |
|
kms_key_id string |
Идентификатор ключа KMS. Возвращается: всегда Пример: |
|
latest_restorable_time string |
Последнее время, до которого базу данных можно восстановить с помощью моментального восстановления. Возвращается: всегда Пример: |
|
license_model string |
Модель лицензирования. Возвращается: всегда Пример: |
|
master_username string |
Имя пользователя-владельца базы данных. Возвращается: всегда Пример: |
|
monitoring_interval integer |
Интервал, в секундах, между точками сбора метрик расширенного мониторинга для экземпляра DB. Возвращается: всегда Пример: |
|
multi_az boolean |
Включена ли функция Multi-AZ. Возвращается: всегда Пример: |
|
option_group_memberships complex |
Список групп параметров. Возвращается: всегда |
|
option_group_name string |
Имя группы параметров. Возвращается: всегда Пример: |
|
status string |
Статус группы параметров. Возвращается: всегда Пример: |
|
pending_modified_values complex |
Измененные значения, ожидающие применения. Возвращается: всегда |
|
performance_insights_enabled boolean |
Включены ли показатели производительности. Возвращается: всегда Пример: |
|
preferred_backup_window string |
Предпочтительное окно резервного копирования. Возвращается: всегда Пример: |
|
preferred_maintenance_window string |
Предпочтительное окно технического обслуживания. Возвращается: всегда Пример: |
|
publicly_accessible boolean |
Доступность БД для публичного доступа. Возвращается: всегда Пример: |
|
read_replica_db_instance_identifiers список / элементы=строка |
Список реплик чтения БД. Возвращается: всегда Пример: |
|
storage_encrypted boolean |
Шифрование хранилища. Возвращается: всегда Пример: |
|
storage_type строка |
Тип хранилища экземпляра базы данных. Возвращается: всегда Пример: |
|
tags сложный |
Теги экземпляра базы данных. Возвращается: всегда |
|
vpc_security_groups сложный |
Список групп безопасности VPC. Возвращается: всегда |
|
status строка |
Статус группы безопасности VPC. Возвращается: всегда Пример: |
|
vpc_security_group_id строка |
Идентификатор группы безопасности VPC. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/amazon/aws/rds_instance_info_module.html