Spec-Zone.ru › Ansible

amazon.aws.backup_plan_info модуль – Описание планов резервного копирования AWS

Примечание

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

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

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

Для использования в плейбуке, укажите: amazon.aws.backup_plan_info.

Добавлена в amazon.aws 6.0.0

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

Описание

  • Отображает информацию о конфигурации плана резервного копирования.

Требования

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

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

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key

строка

ID ключа доступа 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 для соответствия SDK AWS botocore.

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

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

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_names

список / элементы=строка

Указывает список имён планов.

debug_botocore_endpoint_logs

булево

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

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

Варианты:

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

endpoint_url

псевдонимы: ec2_url, aws_endpoint_url, s3_url

строка

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

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

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

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

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 и security_token.

region

псевдонимы: aws_region, ec2_region

строка

Регион 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.

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key, ec2_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, или EC2_SECRET_KEY в порядке убывания приоритета.

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

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

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

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

session_token

псевдонимы: aws_session_token, security_token, aws_security_token, access_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, 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.

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.

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Gather information about all backup plans
  amazon.aws.backup_plan_info:

- name: Gather information about a particular backup plan
  amazon.aws.backup_plan_info:
    backup plan_names:
      - elastic

Значения возврата

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

Ключ

Описание

backup_plans

список / элементы=словарь

Список объектов плана резервного копирования. Элементы списка — это словари с информацией о плане резервного копирования.

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

backup_plan

список / элементы=словарь

Подробная информация о плане резервного копирования.

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

advanced_backup_settings

список / элементы=словарь

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

Возвращается: при конфигурировании

Пример: [{"backup_options": {"windows_vss": "enabled"}, "resource_type": "EC2"}]

backup_options

словарь

Параметры дополнительных настроек.

Возвращается: при успехе

resource_type

строка

Тип ресурса дополнительных настроек.

Возвращается: при успехе

backup_plan_name

строка

Имя плана резервного копирования.

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

Пример: "elastic"

rules

список / элементы=словарь

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

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

completion_window_minutes

целое число

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

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

Пример: 10080
...
END_OF_DOCUMENT_MARKER

target_backup_vault_name

string

Название логического контейнера, в котором хранятся резервные копии.

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

Пример: "09da67966fd5-backup-vault"

backup_plan_arn

string

Идентификатор Amazon Resource Name (ARN), уникально определяющий план резервного копирования.

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

Пример: "arn:aws:backup:eu-central-1:111122223333:backup-plan:1111f877-1ecf-4d79-9718-a861cd09df3b"

backup_plan_id

string

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

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

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

backup_plan_name

string

Отображаемое имя плана резервного копирования.

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

Пример: "elastic"

creation_date

string

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

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

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

last_execution_date

string

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

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

Пример: "2023-03-24T06:30:08.250000+01:00"

tags

string

Теги плана резервного копирования

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

Пример: "{'TagKey1': 'TagValue1', 'TagKey2': 'TagValue2'}"

version_id

string

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

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

Пример: "A2AiAAAmAAAtAxAxAA00AAa0AAAxAxAtA0AmAAA4NDY1ZTZl"

Авторы

  • Gomathi Selvi Srinivasan (@GomathiselviS)
  • 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_plan_info_module.html

Spec-Zone.ru

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