Spec-Zone.ru › Ansible

Модуль amazon.aws.backup_plan_info — описание планов AWS Backup

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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.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 SDK botocore.

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 для анализа уникальных (а не общего числа) вызовов API "resource:action", выполненных во время задачи, и записывать их список в ключ resource_actions результатов задачи. Используйте callback aws_resource_action, чтобы вывести общий список вызовов, выполненных за время плейбука.

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

Варианты:

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

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.

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 SDK botocore.

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 являются взаимоисключающими.

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.

Примеры

# 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

целое число

Время в минутах, отведенное на завершение задания резервного копирования после его успешного запуска; по истечении этого времени Backup отменит задание.

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

Пример: 10080

copy_actions

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

Массив объектов CopyAction со сведениями об операции копирования.

Возвращается: если настроено.

Пример: [{"destination_backup_vault_arn": "arn:aws:backup:us-west-2:123456789012:backup-vault:my-test-vault", "lifecycle": {"delete_after_days": 100, "move_to_cold_storage_after_days": 10}}]

enable_continous_backup

логическое значение

Указывает, создает ли Backup непрерывные резервные копии.

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

Пример: false

lifecycle

словарь

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

Возвращается: если настроено.

Пример: {"delete_after_days": 100, "move_to_cold_storage_after_days": 10}

recovery_point_tags

словарь

Массив строк с парами ключ-значение, которые присваиваются ресурсам, связанным с этим правилом, при восстановлении из резервной копии.

Возвращается: если настроено.

Пример: {"Tagkey1": "TagValue1", "Tagkey2": "TagValue2"}

rule_id

строка

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

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

Пример: "973621ef-d863-41ef-b5c3-9e943a64ad0c"

rule_name

строка

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

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

Пример: "daily"

schedule_expression

строка

Выражение cron в формате UTC, задающее время запуска задания резервного копирования службой Backup.

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

Пример: "cron(0 5 ? * * *)"

start_window_minutes

целое число

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

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

Пример: 480

target_backup_vault_name

строка

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

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

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

backup_plan_arn

строка

Имя ресурса Amazon (ARN), однозначно идентифицирующее план резервного копирования.

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

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

backup_plan_id

строка

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

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

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

backup_plan_name

строка

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

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

Пример: "elastic"

creation_date

строка

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

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

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

last_execution_date

строка

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

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

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

tags

строка

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

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

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

version_id

строка

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

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

Пример: "A2AiAAAmAAAtAxAxAA00AAa0AAAxAxAtA0AmAAA4NDY1ZTZl"

Авторы

  • Gomathi Selvi Srinivasan (@GomathiselviS)
  • Kristof Imre Szabo (@krisek)
  • Alina Buzachis (@alinabuzachis)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Связь с разработчиками

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

Spec-Zone.ru

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