Модуль amazon.aws.backup_selection_info — описание наборов ресурсов AWS Backup

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля необходимы дополнительные требования; подробную информацию см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: amazon.aws.backup_selection_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 строка	Идентификатор ключа доступа AWS. Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_ACCESS_KEY_ID` или `AWS_ACCESS_KEY`, в порядке убывания приоритета. Параметры aws_access_key и profile нельзя использовать одновременно. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore.
aws_ca_bundle путь	Путь к пакету сертификатов CA, используемому для проверки SSL-сертификатов. Также можно использовать переменную среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Описание параметров см. в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
backup_plan_name псевдонимы: plan_name строка / обязательный	Уникально определяет план резервного копирования, с которым будет связан набор ресурсов.
backup_selection_names псевдонимы: selection_names список / элементы=строка	Уникально определяет план резервного копирования, наборы ресурсов которого требуется вывести.
debug_botocore_endpoint_logs логическое значение	Использовать логгер `botocore.endpoint` для анализа уникальных (а не общего числа) вызовов API `"resource:action"`, выполненных во время задачи, и выводить их список в ключ resource_actions результатов задачи. Используйте callback `aws_resource_action`, чтобы вывести общий список вызовов, выполненных за время плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, однако коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды `AWS_URL`.
profile псевдонимы: aws_profile строка	Именованный профиль AWS для аутентификации. Дополнительную информацию об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды `AWS_PROFILE`. Параметр profile нельзя использовать одновременно с параметрами aws_access_key, aws_secret_key и session_token.
region псевдонимы: aws_region строка	Регион AWS, который следует использовать. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды `AWS_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. Также можно использовать переменные среды `AWS_SECRET_ACCESS_KEY` или `AWS_SECRET_KEY`, в порядке убывания приоритета. Параметры 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. Также можно использовать переменную среды `AWS_SESSION_TOKEN`. Параметры session_token и profile нельзя использовать одновременно.
validate_certs логическое значение	Если задано значение `false`, SSL-сертификаты при обмене данными с API AWS проверяться не будут. Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Внимание: Для модулей переменные среды и файлы конфигурации считываются в контексте «хоста» 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.
- name: Gather information about all backup selections
  amazon.aws.backup_selection_info:
    backup_plan_name: "{{ backup_plan_name }}"

- name: Gather information about a particular backup selection
  amazon.aws.backup_selection_info:
    backup_plan_name: "{{ backup_plan_name }}"
    backup_selection_names:
      - "{{ backup_selection_name }}"

Возвращаемые значения

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

Ключ	Описание
backup_selections список / элементы=словарь	Список объектов наборов ресурсов резервного копирования. Каждый элемент представляет собой словарь со всей информацией, относящейся к этому набору ресурсов. Возвращается: всегда
backup_plan_id строка	Идентификатор плана резервного копирования. Возвращается: всегда Пример: `"1111f877-1ecf-4d79-9718-a861cd09df3b"`
conditions словарь	Список условий (в виде словаря), определяющих назначение ресурсов плану резервного копирования с помощью тегов. Возвращается: всегда Пример: `{}`
creation_date строка	Дата создания плана резервного копирования. Возвращается: всегда Пример: `"2023-01-24T10:08:03.193000+01:00"`
iam_role_arn строка	ARN роли IAM. Возвращается: всегда Пример: `"arn:aws:iam::111122223333:role/system-backup"`
list_of_tags список / элементы=словарь	Условия, определяющие назначение ресурсов планам резервного копирования с помощью тегов. Возвращается: всегда Пример: `[]`
not_resources список / элементы=строка	Список имен ресурсов Amazon (ARN), исключенных из плана резервного копирования. Возвращается: всегда Пример: `[]`
resources список / элементы=строка	Список имен ресурсов Amazon (ARN), назначенных плану резервного копирования. Возвращается: всегда Пример: `[]`
selection_id строка	Идентификатор набора ресурсов резервного копирования. Возвращается: всегда Пример: `"1111c217-5d71-4a55-8728-5fc4e63d437b"`
selection_name строка	Имя набора ресурсов резервного копирования. Возвращается: всегда Пример: `"elastic"`

Авторы

Gomathi Selvi Srinivasan (@GomathiselviS)
Kristof Imre Szabo (@krisek)
Alina Buzachis (@alinabuzachis)

Ссылки на коллекцию

© 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_selection_info_module.html