Модуль amazon.aws.backup_selection — создание, удаление и изменение выбора AWS Backup
Примечание
Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля необходимы дополнительные требования; подробную информацию см. в разделе Требования.
Чтобы использовать модуль в playbook, укажите: amazon.aws.backup_selection.
Добавлено в amazon.aws 6.0.0
Краткое описание
- Управляет выборами AWS Backup.
- Дополнительную информацию см. в документации AWS о выборе ресурсов для резервного копирования: https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- python >= 3.6
- boto3 >= 1.35.0
- botocore >= 1.35.0
Параметры
Параметр | Комментарии |
|---|---|
access_key aliases: 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 botocore SDK. |
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_plan_name aliases: plan_name string / обязательный | Уникальный идентификатор плана резервного копирования, связываемого с выбором ресурсов. |
backup_selection_name aliases: selection_name string / обязательный | Отображаемое имя документа выбора ресурсов. Должно содержать от 1 до 50 буквенно-цифровых символов или символов «-_.». |
conditions dictionary | Список условий (в виде словаря), заданных для назначения ресурсов планам резервного копирования с помощью тегов. Если в параметре conditions указано несколько условий, назначаются только ресурсы, соответствующие ВСЕМ условиям (логика И).
|
|
string_equals list / elements=dictionary |
Отбирает помеченные тегами ресурсы, оставляя только ресурсы с таким же значением тега. По умолчанию: |
|
condition_key string |
Ключ в паре «ключ-значение».
|
|
condition_value string |
Значение в паре «ключ-значение». |
|
string_like list / elements=dictionary |
Отбирает помеченные тегами ресурсы по совпадению значений тегов с использованием подстановочного символа (*) в любом месте строки. Например, «prod*» или «*rod*» соответствует значению тега «production». По умолчанию: |
|
condition_key string |
Ключ в паре «ключ-значение».
|
|
condition_value string |
Значение в паре «ключ-значение». |
|
string_not_equals list / elements=dictionary |
Отбирает помеченные тегами ресурсы, оставляя только ресурсы, у которых значение тега отличается. По умолчанию: |
|
condition_key string |
Ключ в паре «ключ-значение».
|
|
condition_value string |
Значение в паре «ключ-значение». |
|
string_not_like list / elements=dictionary |
Отбирает помеченные тегами ресурсы, значения тегов которых не совпадают, используя подстановочный символ (*) в любом месте строки. По умолчанию: |
|
condition_key string |
Ключ в паре «ключ-значение».
|
|
condition_value string |
Значение в паре «ключ-значение». |
debug_botocore_endpoint_logs boolean | Использует регистратор Также можно использовать переменную окружения Варианты:
|
endpoint_url aliases: aws_endpoint_url string | URL для подключения вместо конечных точек AWS по умолчанию. Этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, однако коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную окружения |
iam_role_arn string | ARN роли IAM, которую Backup использует для аутентификации при резервном копировании целевого ресурса. |
list_of_tags list / elements=dictionary | Список условий, заданных для назначения ресурсов планам резервного копирования с помощью тегов. Операторы условий чувствительны к регистру. Если в |
|
condition_key string |
Ключ в паре «ключ-значение». |
|
condition_type string |
Операция, применяемая к паре «ключ-значение» для назначения ресурсов плану резервного копирования. Условие поддерживает только |
|
condition_value string |
Значение в паре «ключ-значение». |
not_resources list / elements=string | Список Amazon Resource Names (ARN), исключаемых из плана резервного копирования. Максимальное количество ARN — 500 без подстановочных символов или 30 с подстановочными символами. Если необходимо исключить из плана много ресурсов, рассмотрите другую стратегию выбора ресурсов, например назначение только одного или нескольких типов ресурсов либо уточнение выбора ресурсов с помощью тегов. |
profile aliases: 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 aliases: aws_region string | Регион AWS для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную окружения Дополнительную информацию см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. |
resources list / elements=string | Список Amazon Resource Names (ARN), назначаемых плану резервного копирования. Максимальное количество ARN — 500 без подстановочных символов или 30 с подстановочными символами. Если необходимо назначить плану много ресурсов, рассмотрите другую стратегию выбора ресурсов, например назначение всех ресурсов определённого типа или уточнение выбора ресурсов с помощью тегов. |
secret_key aliases: 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 botocore SDK. |
session_token aliases: 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 являются взаимоисключающими. |
state string | Создать или удалить выбор ресурсов для резервного копирования. Варианты:
|
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.
Примеры
- name: Create backup selection
amazon.aws.backup_selection:
selection_name: elastic
backup_plan_name: test-backup-plan
iam_role_arn: arn:aws:iam::111122223333:role/system-backup
resources:
- arn:aws:elasticfilesystem:*:*:file-system/*
- name: Create backup selection, assign resources using tags
amazon.aws.backup_selection:
selection_name: elastic
backup_plan_name: test-backup-plan
iam_role_arn: arn:aws:iam::111122223333:role/system-backup
list_of_tags:
- condition_type: STRINGEQUALS
condition_key: Owner
condition_value: Dev01
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
backup_selection complex | Сведения о выборе резервной копии. Возвращается: всегда |
|
backup_plan_id string |
Идентификатор плана резервного копирования. Возвращается: всегда Пример: |
|
conditions dictionary |
Список условий, определяющих назначение ресурсов планам резервного копирования с помощью тегов. Возвращается: всегда Пример: |
|
string_equals list / elements=string |
Фильтрует значения тегированных ресурсов, оставляя только ресурсы с тем же значением тега. Возвращается: всегда Пример: |
|
string_like list / elements=string |
Фильтрует значения тегированных ресурсов, выбирая совпадающие значения тегов. Для поиска в любом месте строки можно использовать подстановочный символ (*). Возвращается: всегда Пример: |
|
string_not_equals list / elements=string |
Фильтрует значения тегированных ресурсов, оставляя только ресурсы, у которых значение тега отличается. Возвращается: всегда Пример: |
|
string_not_like list / elements=string |
Фильтрует значения тегированных ресурсов, выбирая несовпадающие значения тегов. Для поиска в любом месте строки можно использовать подстановочный символ (*). Возвращается: всегда Пример: |
|
creation_date string |
Дата создания плана резервного копирования. Возвращается: при создании/обновлении Пример: |
|
iam_role_arn string |
ARN роли IAM, которую Backup использует для аутентификации при создании резервной копии целевого ресурса. Возвращается: всегда Пример: |
|
list_of_tags list / elements=dictionary |
Условия назначения ресурсов планам резервного копирования с помощью тегов. Возвращается: всегда Пример: |
|
condition_key string |
Ключ в паре «ключ-значение». Возвращается: всегда Пример: |
|
condition_type string |
Операция над парой «ключ-значение», используемая для назначения ресурсов плану резервного копирования. Возвращается: всегда Пример: |
|
condition_value string |
Значение в паре «ключ-значение». Возвращается: всегда Пример: |
|
not_resources list / elements=string |
Список Amazon Resource Names (ARN) ресурсов, исключённых из плана резервного копирования. Возвращается: всегда Пример: |
|
resources list / elements=string |
Список Amazon Resource Names (ARN) ресурсов, назначенных плану резервного копирования. Возвращается: всегда Пример: |
|
selection_id string |
Идентификатор выбора резервной копии. Возвращается: всегда Пример: |
|
selection_name string |
Отображаемое имя документа выбора ресурсов. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_module.html