Модуль amazon.aws.backup_vault_info – Описание хранилищ резервных копий AWS
Примечание
Этот модуль является частью коллекции amazon.aws (версия 8.2.1).
Возможно, эта коллекция уже установлена, если вы используете пакет 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.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка | ID ключа доступа 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. |
backup_vault_names список / элементы=строка | Указывает список имен хранилищ. Если указан пустой список, возвращается информация о хранилищах резервных копий в текущем регионе. Значение по умолчанию: |
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. Поддержка переменной среды |
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, регион игнорируется. Также можно использовать переменные среды Дополнительную информацию см. в документации 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 псевдонимы: aws_session_token, security_token, aws_security_token, access_token строка | Токен сеанса AWS STS для использования с временными учетными данными. Дополнительную информацию об маркерах доступа см. в документации AWS 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.
Примеры
# 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 список / элементы=словарь | Список объектов резервного хранилища. Каждый элемент представляет собой словарь со всей информацией о данном резервном хранилище. Возвращается: всегда |
|
backup_vault_arn строка |
ARN резервного хранилища. Возвращается: успешно Пример: |
|
backup_vault_name строка |
Имя резервного хранилища. Возвращается: успешно Пример: |
|
creation_date строка |
Дата и время создания резервного хранилища в формате Unix и по Гринвичу (UTC). Возвращается: успешно Пример: |
|
creator_request_id строка |
Уникальная строка, идентифицирующая запрос и позволяющая повторно выполнить неудачные запросы без риска повторного выполнения операции. Возвращается: успешно |
|
encryption_key_arn строка |
Ключ шифрования на стороне сервера, используемый для защиты резервных копий. Возвращается: успешно Пример: |
|
lock_date строка |
Дата и время, когда конфигурация блокировки резервного хранилища не может быть изменена или удалена. Возвращается: успешно Пример: |
|
locked boolean |
Указывает, защищает ли Блокировка резервного хранилища резервное хранилище в настоящее время. True означает, что Блокировка хранилища приводит к тому, что операции удаления или обновления точек восстановления, хранящихся в хранилище, завершаются ошибкой. Возвращается: успешно Пример: |
|
max_retention_days целое число |
Максимальный срок хранения, в течение которого хранилище сохраняет свои точки восстановления. Если этот параметр не указан, Блокировка хранилища не накладывает максимальный срок хранения (разрешая неограниченное хранение). Возвращается: успешно Пример: |
|
min_retention_days целое число |
Минимальный срок хранения, в течение которого хранилище сохраняет свои точки восстановления. Если этот параметр не указан, Блокировка хранилища не накладывает минимальный срок хранения. Возвращается: успешно Пример: |
|
number_of_recovery_points целое число |
Количество точек восстановления, хранящихся в резервном хранилище. Возвращается: успешно |
Ссылки на коллекцию
© 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/backup_vault_info_module.html
