Spec-Zone.ru › Ansible

Модуль amazon.aws.backup_selection — Создание, удаление и изменение выбора резервного копирования AWS

Примечание

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

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

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

Для использования в книге задач укажите: amazon.aws.backup_selection.

Новая в amazon.aws 6.0.0

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

  • Управляет выбором резервных копий AWS.
  • Дополнительную информацию см. в документации AWS по выбору резервных копий https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • python >= 3.6
  • boto3 >= 1.26.0
  • botocore >= 1.29.0
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

access_key

aliases: aws_access_key_id, aws_access_key, ec2_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_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY также могут использоваться в порядке убывания предпочтения.

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

aws_ca_bundle

path

Расположение пакета CA, используемого при проверке SSL-сертификатов.

Переменная среды AWS_CA_BUNDLE также может использоваться.

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 / required

Уникально идентифицирует план резервного копирования, который будет связан с выбором ресурсов.

backup_selection_name

aliases: selection_name

string / required

Отображаемое имя документа выбора ресурсов. Должно содержать от 1 до 50 буквенно-цифровых символов или символов ‘-_.’.

conditions

dictionary

Список условий (выраженных в виде словаря), которые вы определяете для назначения ресурсов вашим планам резервного копирования с использованием тегов.

Когда вы указываете более одного условия в conditions, вы назначаете только ресурсы, которые соответствуют ВСЕМ условиям (используя логику И).

conditions поддерживает string_equals, string_like, string_not_equals и string_not_like. list_of_tags поддерживает только string_equals.

string_equals

list / elements=dictionary

Фильтры значений ваших помеченных ресурсов только для тех ресурсов, которые вы пометили тем же значением.

Default: []

condition_key

string

Ключ в паре ключ-значение.

conditions.string_equals.condition_key в параметре conditions должен использовать префикс тега ресурса AWS, например, ‘aws:ResourceTag/key-name’

condition_value

string

Значение в паре ключ-значение.

string_like

list / elements=dictionary

Фильтры значений ваших помеченных ресурсов для соответствия значениям тегов с использованием подстановочного знака (*) в любом месте строки. Например, “prod*” или “*rod*” соответствует значению тега “production”.

Default: []

condition_key

string

Ключ в паре ключ-значение.

conditions.string_like.condition_key в параметре conditions должен использовать префикс тега ресурса AWS, например, ‘aws:ResourceTag/key-name’

condition_value

string

Значение в паре ключ-значение.

string_not_equals

list / elements=dictionary

Фильтры значений ваших помеченных ресурсов только для тех ресурсов, которые вы пометили и которые не имеют того же значения.

Default: []

condition_key

string

Ключ в паре ключ-значение.

conditions.string_not_equals.condition_key в параметре conditions должен использовать префикс тега ресурса AWS, например, ‘aws:ResourceTag/key-name’

condition_value

string

Значение в паре ключ-значение.

string_not_like

list / elements=dictionary

Фильтры значений ваших помеченных ресурсов для несоответствующих значений тегов с использованием подстановочного знака (*) в любом месте строки.

Default: []

condition_key

string

Ключ в паре ключ-значение.

conditions.string_not_like.condition_key в параметре conditions должен использовать префикс тега ресурса AWS, например, ‘aws:ResourceTag/key-name’

condition_value

string

Значение в паре ключ-значение.

debug_botocore_endpoint_logs

boolean

Использовать botocore.endpoint логгер для анализа уникальных (а не общих) "resource:action" API-вызовов, сделанных во время задачи, выводив набор в ключ resource_actions результатов задачи. Используйте aws_resource_action обратный вызов для вывода общего списка, созданного во время выполнения книги задач.

Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.

Выбор:

  • false ← (по умолчанию)
  • true

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только с AWS.

Также могут использоваться переменные среды AWS_URL или EC2_URL, в порядке убывания предпочтения.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

iam_role_arn

string

ARN роли IAM, которую Backup использует для аутентификации при резервном копировании целевого ресурса.

list_of_tags

list / elements=dictionary

Список условий, которые вы определяете для назначения ресурсов к вашим планам резервного копирования с использованием тегов.

Операторы условий чувствительны к регистру.

При указании более одного условия в list_of_tags, вы назначаете все ресурсы, соответствующие хотя бы одному условию (с использованием логики ИЛИ).

condition_key

string

Ключ в паре ключ-значение.

condition_type

string

Операция, применяемая к паре ключ-значение, используемой для назначения ресурсов вашему плану резервного копирования.

Условие поддерживает только STRINGEQUALS.

condition_value

string

Значение в паре ключ-значение.

not_resources

list / elements=string

Список Amazon Resource Names (ARN) для исключения из плана резервного копирования. Максимальное количество ARN — 500 без подстановочных знаков или 30 ARN с подстановочными знаками. Если вам нужно исключить множество ресурсов из плана резервного копирования, рассмотрите другую стратегию выбора ресурсов, например, назначение только одного или нескольких типов ресурсов или уточнение выбора ресурсов с помощью тегов.

profile

aliases: aws_profile

string

Используемый именованный профиль AWS для аутентификации.

Дополнительную информацию об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также может использоваться переменная среды AWS_PROFILE.

Параметр profile несовместим с параметрами aws_access_key, aws_secret_key и security_token.

region

aliases: aws_region, ec2_region

string

Используемый регион AWS.

Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется.

Также могут использоваться переменные среды AWS_REGION или EC2_REGION.

Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Псевдоним ec2_region устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

resources

list / elements=string

Список Amazon Resource Names (ARN) для назначения плану резервного копирования. Максимальное количество ARN — 500 без подстановочных знаков или 30 ARN с подстановочными знаками. Если вам нужно назначить много ресурсов плану резервного копирования, рассмотрите другую стратегию выбора ресурсов, например, назначение всех ресурсов определенного типа или уточнение выбора ресурсов с помощью тегов.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

Секретный ключ доступа 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, или EC2_SECRET_KEY, в порядке убывания предпочтения.

Параметры secret_key и profile взаимоисключающие.

Псевдоним aws_secret_access_key добавлен в релизе 5.1.0 для согласованности с SDK botocore AWS.

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_SECRET_KEY устарела и будет удалена в релизе после 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

Токен сеанса AWS STS для использования с временными учетными данными.

См. документацию AWS для получения дополнительной информации об access token https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также могут использоваться переменные среды AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

Параметры 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.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

state

string

Создать, удалить резервное копирование.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

validate_certs

boolean

При установке в false, сертификаты SSL не будут проверены для связи с API AWS.

Установка validate_certs=false категорически не рекомендуется; вместо этого рассмотрите возможность установки aws_ca_bundle.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не «контроллер». Поэтому файлы, возможно, нужно явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не «хост».
  • AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте 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

Идентификатор плана резервного копирования.

Возвращается: всегда

Пример: "1111f877-1ecf-4d79-9718-a861cd09df3b"

conditions

dictionary

Список условий, определяющих, как ресурсы назначаются планам резервного копирования с помощью тегов.

Возвращается: всегда

Пример: {"string_equals": [], "string_like": [], "string_not_equals": [], "string_not_like": []}

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

Дата создания плана резервного копирования.

Возвращается: при создании/обновлении

Пример: "2023-01-24T10:08:03.193000+01:00"

iam_role_arn

string

ARN роли IAM, которую Backup использует для аутентификации при резервном копировании целевого ресурса.

Возвращается: всегда

Пример: "arn:aws:iam::111122223333:role/system-backup"

list_of_tags

list / elements=dictionary

Условия, определённые для назначения ресурсов планам резервного копирования с помощью тегов.

Возвращается: всегда

Пример: [{"condition_key": "Environment", "condition_type": "STRINGEQUALS", "condition_value": "Dev"}]

condition_key

string

Ключ в паре ключ-значение.

Возвращается: всегда

Пример: "Environment"

condition_type

string

Операция, применяемая к паре ключ-значение, используемая для назначения ресурсов плану резервного копирования.

Возвращается: всегда

Пример: "STRINGEQUALS"

condition_value

string

Значение в паре ключ-значение.

Возвращается: всегда

Пример: "Dev"

not_resources

list / elements=string

Список имен артефактов Amazon Resource Names (ARN), которые исключены из плана резервного копирования.

Возвращается: всегда

Пример: []

resources

list / elements=string

Список имен артефактов Amazon Resource Names (ARN), которые назначены плану резервного копирования.

Возвращается: всегда

Пример: []

selection_id

string

Идентификатор выбора резервного копирования.

Возвращается: всегда

Пример: "1111c217-5d71-4a55-8728-5fc4e63d437b"

selection_name

string

Имя отображаемого имени документа выбора ресурса.

Возвращаемое значение: всегда

Пример: "elastic"

Авторы

  • Kristof Imre Szabo (@krisek)
  • Alina Buzachis (@alinabuzachis)

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

  • Отслеживание проблем
  • Репозиторий (источники)
  • Общение

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API