Модуль amazon.aws.rds_snapshot_info — получение информации об одном или нескольких снимках RDS
Примечание
Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: amazon.aws.rds_snapshot_info.
Добавлено в amazon.aws 5.0.0
Краткое описание
- Получение информации об одном или нескольких снимках RDS. Это могут быть снимки отдельных баз данных или снимки кластеров БД (Aurora).
- Информацию о снимках Aurora можно получить, если параметры идентификатора не указаны или указан один из параметров кластера.
- Этот модуль впервые добавлен в
community.awsв выпуске 1.0.0.
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- python >= 3.6
- boto3 >= 1.35.0
- botocore >= 1.35.0
Параметры
Параметр | Комментарии |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_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 для соответствия AWS SDK botocore. |
aws_ca_bundle путь | Путь к набору сертификатов центра сертификации, используемому для проверки SSL-сертификатов. Также можно использовать переменную окружения |
aws_config словарь | Словарь для изменения конфигурации botocore. Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
db_cluster_identifier строка | Имя кластера RDS, для которого необходимо найти снимки. Взаимоисключающий параметр с |
db_cluster_snapshot_identifier строка | Имя снимка кластера RDS. Взаимоисключающий параметр с |
db_instance_identifier строка | Имя экземпляра RDS, для которого необходимо найти снимки. Взаимоисключающий параметр с |
db_snapshot_identifier псевдонимы: snapshot_name строка | Имя снимка RDS (не кластерного). Взаимоисключающий параметр с |
debug_botocore_endpoint_logs логическое значение | Использовать регистратор Также можно использовать переменную окружения Варианты:
|
endpoint_url псевдонимы: aws_endpoint_url строка | URL для подключения вместо конечных точек AWS по умолчанию. Его можно использовать для подключения к другим сервисам, совместимым с AWS, однако коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную окружения |
profile псевдонимы: aws_profile строка | Именованный профиль AWS для аутентификации. Дополнительную информацию об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную окружения Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token. |
region псевдонимы: aws_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 строка | Секретный ключ доступа 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 для соответствия AWS SDK botocore. |
session_token псевдонимы: aws_session_token строка | Токен сеанса AWS STS для использования с временными учетными данными. Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную окружения Параметры session_token и profile взаимоисключающие. |
snapshot_type строка | Тип искомого снимка. По умолчанию возвращаются и автоматические, и ручные снимки. Варианты:
|
validate_certs логическое значение | Если установлено значение Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные окружения и файлы конфигурации считываются в контексте «хоста» Ansible, а не «контроллера». Поэтому файлы может потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные окружения и файлы конфигурации считываются в контексте «контроллера» Ansible, а не «хоста».
- Используемый Ansible пакет AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте «хоста» Ansible (обычно
~/.aws/credentials). Дополнительную информацию см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.
Примеры
- name: Get information about an snapshot
amazon.aws.rds_snapshot_info:
db_snapshot_identifier: snapshot_name
register: new_database_info
- name: Get all RDS snapshots for an RDS instance
amazon.aws.rds_snapshot_info:
db_instance_identifier: helloworld-rds-master
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
cluster_snapshots complex | Список снимков кластеров. Возвращается: при передаче параметров кластера. |
|
allocated_storage integer |
Выделенный размер хранилища в гибибайтах (GiB). Возвращается: всегда Пример: |
|
availability_zones list / elements=string |
Список зон доступности (AZ), в которых можно восстановить экземпляры из снимка кластера БД. Возвращается: всегда Пример: |
|
cluster_create_time string |
Время создания кластера БД. Возвращается: всегда Пример: |
|
db_cluster_identifier string |
Идентификатор кластера БД, из которого был создан этот снимок кластера БД. Возвращается: всегда Пример: |
|
db_cluster_resource_id string |
Идентификатор ресурса кластера БД, из которого был создан этот снимок кластера БД. Возвращается: всегда Пример: |
|
db_cluster_snapshot_arn string |
Имя ресурса Amazon (ARN) снимка кластера БД.6 Возвращается: всегда Пример: |
|
db_cluster_snapshot_identifier string |
Идентификатор снимка кластера БД. Возвращается: всегда Пример: |
|
engine string |
Название обработчика базы данных для этого снимка кластера БД. Возвращается: всегда Пример: |
|
engine_mode string |
Режим работы обработчика базы данных для этого снимка кластера БД. Возвращается: всегда Пример: |
|
engine_version string |
Версия обработчика базы данных для этого снимка кластера БД. Возвращается: всегда Пример: |
|
iam_database_authentication_enabled boolean |
Включено ли сопоставление учетных записей Amazon Web Services Identity and Access Management (IAM) с учетными записями базы данных. Возвращается: всегда Пример: |
|
kms_key_id string |
Идентификатор ключа Amazon Web Services KMS для зашифрованного снимка кластера БД. Возвращается: если storage_encrypted имеет значение true Пример: |
|
license_model string |
Сведения о модели лицензирования для этого снимка кластера БД. Возвращается: всегда Пример: |
|
master_username string |
Имя пользователя master для этого снимка кластера БД. Возвращается: всегда Пример: |
|
percent_progress integer |
Процент расчетного объема данных, переданный на данный момент. Возвращается: всегда Пример: |
|
port integer |
Порт, на котором кластер БД прослушивал соединения в момент создания снимка. Возвращается: всегда Пример: |
|
snapshot_create_time string |
Время создания снимка. Возвращается: всегда Пример: |
|
snapshot_type string |
Тип снимка кластера БД. Возвращается: всегда Пример: |
|
status string |
Статус этого снимка кластера БД. Возвращается: всегда Пример: |
|
storage_encrypted boolean |
Указывает, зашифрован ли снимок кластера БД. Возвращается: всегда Пример: |
|
tags complex |
Теги снимка. Возвращается: если снимок не является общим. |
|
vpc_id string |
Идентификатор VPC, связанной со снимком кластера БД. Возвращается: всегда Пример: |
snapshots complex | Список снимков, не относящихся к кластерам. Возвращается: если параметры кластера не переданы. |
|
allocated_storage integer |
Выделенный размер хранилища в гибибайтах (GiB). Возвращается: всегда Пример: |
|
availability_zone string |
Название зоны доступности, в которой находился экземпляр БД на момент создания снимка БД. Возвращается: всегда Пример: |
|
db_instance_identifier string |
Идентификатор экземпляра БД, из которого был создан этот снимок БД. Возвращается: всегда Пример: |
|
db_snapshot_arn string |
Имя ресурса Amazon (ARN) снимка БД. Возвращается: всегда Пример: |
|
db_snapshot_identifier string |
Идентификатор снимка БД. Возвращается: всегда Пример: |
|
dbi_resource_id string |
Идентификатор исходного экземпляра БД, который нельзя изменить и который уникален для каждого региона Amazon Web Services. Возвращается: всегда Пример: |
|
dedicated_log_volume boolean |
Включен ли для экземпляра БД выделенный том журналов (DLV). Возвращается: всегда Пример: |
|
encrypted boolean |
Зашифрован ли снимок БД. Возвращается: всегда Пример: |
|
engine string |
Название обработчика базы данных. Возвращается: всегда Пример: |
|
engine_version string |
Версия обработчика базы данных. Возвращается: всегда Пример: |
|
iam_database_authentication_enabled boolean |
Включено ли сопоставление учетных записей Amazon Web Services Identity and Access Management (IAM) с учетными записями базы данных. Возвращается: всегда Пример: |
|
instance_create_time string |
Время создания экземпляра БД, с которого был сделан снимок. Возвращается: всегда Пример: |
|
iops integer |
Значение Provisioned IOPS (операций ввода-вывода в секунду) для экземпляра БД на момент создания снимка. Возвращается: всегда Пример: |
|
kms_key_id string |
Идентификатор ключа Amazon Web Services KMS для зашифрованного снимка БД. Возвращается: если encrypted имеет значение true Пример: |
|
license_model string |
Сведения о модели лицензирования восстановленного экземпляра БД. Возвращается: всегда Пример: |
|
master_username string |
Имя пользователя master для снимка БД. Возвращается: всегда Пример: |
|
multi_tenant boolean |
Создан ли снимок экземпляра БД с конфигурацией для нескольких арендаторов (TRUE) или одного арендатора (FALSE). Возвращается: всегда Пример: |
|
option_group_name string |
Название группы параметров для снимка БД. Возвращается: всегда Пример: |
|
original_snapshot_create_time string |
Время выполнения операции CreateDBSnapshot. Не меняется при копировании снимка. Возвращается: всегда Пример: |
|
percent_progress integer |
Процент расчетного объема данных, переданный на данный момент. Возвращается: всегда Пример: |
|
port integer |
Порт, на котором обработчик базы данных прослушивал соединения в момент создания снимка. Возвращается: всегда Пример: |
|
snapshot_create_time string |
Время создания снимка. Возвращается: всегда Пример: |
|
snapshot_target string |
Где хранятся ручные снимки: в Amazon Web Services Outposts или в регионе Amazon Web Services. Возвращается: всегда Пример: |
|
snapshot_type string |
Тип снимка БД. Возвращается: всегда Пример: |
|
status string |
Статус этого снимка БД. Возвращается: всегда Пример: |
|
storage_throughput integer |
Пропускная способность хранилища для снимка БД. Возвращается: всегда Пример: |
|
storage_type string |
Тип хранилища, связанный со снимком БД. Возвращается: всегда Пример: |
|
tags complex |
Теги снимка. Возвращается: если снимок не является общим. |
|
vpc_id string |
Идентификатор VPC, связанной со снимком БД. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/rds_snapshot_info_module.html