Модуль amazon.aws.backup_vault – Управление хранилищами резервных копий AWS
Примечание
Этот модуль является частью коллекции amazon.aws (версия 8.2.1).
Возможно, эта коллекция уже установлена, если вы используете пакет 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.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
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 и profile являются взаимоисключающими. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
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_vault_name string / required | Имя для хранилища резервных копий. Имена уникальны для учетной записи, используемой для их создания, и региона Amazon Web Services, в котором они создаются. Они состоят из букв, цифр и дефисов. |
creator_request_id string | Уникальная строка, идентифицирующая запрос и позволяющая повторять неудачные запросы без риска дважды выполнить операцию. При использовании этот параметр должен содержать от 1 до 50 буквенно-цифровых символов или символов “-_.”. |
debug_botocore_endpoint_logs boolean | Использовать Переменная среды Варианты:
|
encryption_key_arn string | Серверный ключ шифрования, используемый для защиты резервных копий. |
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string | URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только на AWS. Переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
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 и security_token. |
purge_tags boolean | Если purge_tags=true и задан tags, существующие теги будут очищены из ресурса, чтобы точно соответствовать тому, что определено параметром tags. Если параметр tags не задан, теги не будут изменены, даже если purge_tags=True. Ключи тегов, начинающиеся с Варианты:
|
region aliases: aws_region, ec2_region string | Регион AWS для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, region игнорируется. Переменные среды См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной среды |
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. Также могут использоваться переменные среды Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удалён в релизе после 2024-12-01. Поддержка переменной среды |
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string | Токен сессии 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. Поддержка переменных среды |
state string | Добавить или удалить конфигурацию хранилища резервных копий. Варианты:
|
tags aliases: resource_tags dictionary | Словарь, представляющий теги, которые необходимо применить к ресурсу. Если параметр tags не задан, теги не будут изменены. |
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 для получения дополнительной информации.
Примеры
- 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 boolean | Существует ли резервная хранилище? Возвращается: всегда Пример: |
vault complex | Подробности резервного хранилища. Возвращается: всегда Пример: |
|
backup_vault_arn string |
Идентификатор Amazon Resource Name (ARN), уникально определяющий резервное хранилище. Возвращается: всегда Пример: |
|
backup_vault_name string |
Название логического контейнера, в котором хранятся резервные копии. Возвращается: всегда Пример: |
|
creation_date string |
Дата и время создания резервного хранилища в формате Unix и в формате Coordinated Universal Time (UTC). Возвращается: всегда Пример: |
|
encryption_key_arn string |
Ключ шифрования на стороне сервера, используемый для защиты резервных копий. Возвращается: всегда Пример: |
|
locked boolean |
Логическое значение, указывающее, защищает ли в настоящее время блокировка резервного хранилища данное резервное хранилище. Значение True означает, что блокировка хранилища приводит к тому, что операции удаления или обновления точек восстановления, хранящихся в хранилище, завершаются неудачей. Возвращается: всегда Пример: |
|
number_of_recovery_points integer |
Количество точек восстановления, хранящихся в резервном хранилище. Возвращается: всегда Пример: |
|
tags string |
Теги резервного хранилища. Возвращается: при создании/обновлении Пример: |
Ссылки на коллекцию
© 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_module.html
