Модуль amazon.aws.backup_vault_info — описание хранилищ AWS Backup
Примечание
Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: amazon.aws.backup_vault_info.
Добавлено в amazon.aws 6.0.0
Краткое описание
- Выводит сведения о конфигурации хранилищ резервных копий.
Требования
Следующие требования должны быть выполнены на узле, на котором выполняется этот модуль.
- python >= 3.6
- boto3 >= 1.35.0
- botocore >= 1.35.0
Параметры
Параметр | Комментарии |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_access_key string | Идентификатор ключа доступа 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 path | Путь к пакету сертификатов CA, используемому для проверки сертификатов SSL. Также можно использовать переменную среды |
aws_config dictionary | Словарь для изменения конфигурации botocore. Описание параметров см. в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
backup_vault_names list / элементы=string | Список имен хранилищ. Если указан пустой список, возвращается информация о хранилищах резервных копий в текущем регионе. По умолчанию: |
debug_botocore_endpoint_logs boolean | Использовать регистратор Также можно использовать переменную среды Варианты:
|
endpoint_url псевдонимы: aws_endpoint_url string | URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды |
profile псевдонимы: aws_profile string | Именованный профиль 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 string | Регион 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 string | Секретный ключ доступа 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 string | Токен сеанса 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 являются взаимоисключающими. |
validate_certs boolean | Если задано значение Настоятельно не рекомендуется задавать 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.
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
# Gather information about all backup vaults
- amazon.aws.backup_vault_info
# Gather information about a particular backup vault
- amazon.aws.backup_vault_info:
backup vault_names:
- "arn:aws:backup_vault:us-east-2:123456789012:backup_vault/defaultvault"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; далее перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
backup_vaults list / элементы=dictionary | Список объектов хранилищ резервных копий. Каждый элемент — это словарь со всей информацией о соответствующем хранилище. Возвращается: всегда |
|
backup_vault_arn string |
ARN хранилища резервных копий. Возвращается: при успешном выполнении Пример: |
|
backup_vault_name string |
Имя хранилища резервных копий. Возвращается: при успешном выполнении Пример: |
|
creation_date string |
Дата и время создания хранилища резервных копий в формате Unix и по всемирному координированному времени (UTC). Возвращается: при успешном выполнении Пример: |
|
creator_request_id string |
Уникальная строка, идентифицирующая запрос и позволяющая повторить неудачный запрос без риска выполнить операцию дважды. Возвращается: при успешном выполнении |
|
encryption_key_arn string |
Ключ шифрования на стороне сервера, используемый для защиты резервных копий. Возвращается: при успешном выполнении Пример: |
|
lock_date string |
Дата и время, после наступления которых конфигурацию блокировки хранилища резервных копий нельзя изменить или удалить. Возвращается: при успешном выполнении Пример: |
|
locked boolean |
Указывает, защищает ли в данный момент хранилище блокировка хранилища резервных копий. Значение True означает, что блокировка хранилища приводит к сбою операций удаления или обновления точек восстановления, хранящихся в хранилище. Возвращается: при успешном выполнении Пример: |
|
max_retention_days integer |
Максимальный срок хранения точек восстановления в хранилище. Если этот параметр не указан, блокировка хранилища не ограничивает максимальный срок хранения (допускается бессрочное хранение). Возвращается: при успешном выполнении Пример: |
|
min_retention_days integer |
Минимальный срок хранения точек восстановления в хранилище. Если этот параметр не указан, блокировка хранилища не устанавливает минимальный срок хранения. Возвращается: при успешном выполнении Пример: |
|
number_of_recovery_points integer |
Количество точек восстановления, хранящихся в хранилище резервных копий. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 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/backup_vault_info_module.html