Модуль amazon.aws.backup_vault — управление хранилищами резервных копий AWS

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: amazon.aws.backup_vault.

Новое в 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 botocore SDK.
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_vault_name строка / обязательный	Имя хранилища резервных копий. Имена уникальны для учётной записи, используемой для их создания, и региона Amazon Web Services, в котором они созданы. Имя может содержать буквы, цифры и дефисы.
creator_request_id строка	Уникальная строка, идентифицирующая запрос и позволяющая повторять неудачные запросы без риска выполнить операцию дважды. Если параметр используется, его значение должно содержать от 1 до 50 буквенно-цифровых символов или символов «-_.”».
debug_botocore_endpoint_logs логический	Используйте регистратор `botocore.endpoint` для подсчёта уникальных (а не общего числа) вызовов API `"resource:action"`, выполненных во время задачи. Список записывается в ключ resource_actions результатов задачи. Используйте обработчик `aws_resource_action`, чтобы вывести общий список вызовов, выполненных в плейбуке. Также можно использовать переменную окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
encryption_key_arn строка	Ключ шифрования на стороне сервера, используемый для защиты резервных копий.
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.
purge_tags логический	Если задано значение `purge_tags=true` и указан параметр `tags`, существующие теги ресурса будут удалены, чтобы они в точности соответствовали значениям параметра `tags`. Если параметр `tags` не задан, теги не будут изменены, даже если задано значение `purge_tags=True`. Ключи тегов, начинающиеся с `aws:`, зарезервированы Amazon и не могут быть изменены. Поэтому они не учитываются при обработке параметра `purge_tags`. Подробнее см. в документации Amazon: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions. Варианты: `false` `true` ← (по умолчанию)
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 botocore SDK.
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 являются взаимоисключающими.
state строка	Добавление или удаление конфигурации хранилища резервных копий. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags псевдонимы: resource_tags словарь	Словарь с тегами, которые нужно применить к ресурсу. Если параметр `tags` не задан, теги не будут изменены.
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.

Примеры

- name: create backup vault
  amazon.aws.backup_vault:
    state: present
    backup_vault_name: default-vault
    encryption_key_arn: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    tags:
      environment: dev
      Name: default

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

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

Ключ	Описание
exists логический	Существует ли хранилище резервных копий. Возвращается: всегда Пример: `true`
vault сложный тип	Сведения о хранилище резервных копий. Возвращается: всегда Пример: `"hash/dictionary of values"`
backup_vault_arn строка	Имя ресурса Amazon (ARN), однозначно идентифицирующее хранилище резервных копий. Возвращается: всегда Пример: `"arn:aws:backup:us-east-1:123456789012:vault:aBackupVault"`
backup_vault_name строка	Имя логического контейнера, в котором хранятся резервные копии. Возвращается: всегда Пример: `"default-name"`
creation_date строка	Дата и время создания хранилища резервных копий в формате Unix и по всемирному координированному времени (UTC). Возвращается: всегда Пример: `"2024-05-21T13:21:10.062000-07:00"`
encryption_key_arn строка	Ключ шифрования на стороне сервера, используемый для защиты резервных копий. Возвращается: всегда Пример: `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
locked логический	Логическое значение, указывающее, защищает ли в данный момент блокировка Backup Vault Lock хранилище резервных копий. Значение True означает, что Vault Lock не позволяет выполнять операции удаления или обновления точек восстановления, хранящихся в хранилище. Возвращается: всегда Пример: `false`
number_of_recovery_points целое число	Количество точек восстановления, хранящихся в хранилище резервных копий. Возвращается: всегда Пример: `0`
tags строка	Теги хранилища резервных копий. Возвращается: при создании/обновлении Пример: `"{'TagKey1': 'TagValue1', 'TagKey2': 'TagValue2'}"`

Авторы

Gomathi Selvi Srinivasan (@GomathiselviS)

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

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