amazon.aws.backup_plan модуль — Управление планами резервного копирования AWS

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

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

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

advanced_backup_settings

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

Указывает список расширенных параметров резервного копирования для каждого типа ресурса.

Эти параметры доступны только для задач резервного копирования службой Volume Shadow Copy Service (VSS) Windows.

backup_options

словарь

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

Этот параметр доступен только для задач резервного копирования Windows VSS.

WindowsVSS

строка

Включить или выключить параметр резервного копирования WindowsVSS.

Варианты:

• "enabled"
• "disabled"

resource_type

строка

Указывает объект, содержащий тип ресурса и параметры резервного копирования.

Поддерживается только тип ресурса — экземпляры Amazon EC2 с Windows Volume Shadow Copy Service (VSS).

Варианты:

• "EC2"

aws_ca_bundle

путь

Расположение файла CA Bundle для проверки SSL-сертификатов.

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

aws_config

словарь

Словарь для модификации конфигурации botocore.

Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

backup_plan_name

псевдонимы: name

строка / обязательно

Имя плана резервного копирования. Должно содержать от 1 до 50 символов латинского алфавита, цифр или символов ‘-_.’.

creator_request_id

строка

Идентифицирует запрос и позволяет повторно выполнить проваленные запросы без риска повторного выполнения операции. Если запрос содержит CreatorRequestId, совпадающий с существующим планом резервного копирования, этот план возвращается.

debug_botocore_endpoint_logs

логический тип

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

Также может быть использована переменная среды 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.

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

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.

rules

list / elements=dictionary

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

Обязательно, когда state=present.

completion_window_minutes

integer

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

Значение по умолчанию AWS, если не указано, равно 10080.

Default: 10080

copy_actions

list / elements=dictionary

Массив объектов copy_action, содержащий сведения об операции копирования.

destination_backup_vault_arn

string / required

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

lifecycle

dictionary

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

Резервные копии, переведенные в холодное хранилище, должны храниться в холодном хранилище не менее 90 дней. Поэтому в консоли параметр «сохранение» должен быть на 90 дней больше, чем параметр «перевод в холодное хранилище через дни». Параметр «перевод в холодное хранилище через дни» нельзя изменить после того, как резервная копия была переведена в холодное хранилище.

delete_after_days

integer

Указывает количество дней после создания, по истечении которых точка восстановления удаляется. Должно быть больше, чем 90 дней плюс rules.copy_actions.lifecycle.move_to_cold_storage_after_days.

move_to_cold_storage_after_days

integer

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

enable_continuous_backup

boolean

Указывает, создает ли Backup непрерывные резервные копии. Значение True приводит к тому, что Backup создает непрерывные резервные копии, допускающие восстановление в определенный момент времени (PITR). Значение False (или не указано) приводит к тому, что Backup создает резервные копии моментальных снимков.

Значение по умолчанию AWS, если не указано, равно false.

Choices:

• false ← (default)
• true

lifecycle

dictionary

Жизненный цикл определяет, когда защищенный ресурс переводится в холодное хранилище и когда он истекает. Backup будет автоматически переводить и удалять резервные копии в соответствии с определенным вами жизненным циклом.

Резервные копии, переведенные в холодное хранилище, должны храниться в холодном хранилище не менее 90 дней. Поэтому параметр «сохранение» должен быть на 90 дней больше, чем параметр «перевод в холодное хранилище через дни». Параметр «перевод в холодное хранилище через дни» нельзя изменить после того, как резервная копия была переведена в холодное хранилище.

delete_after_days

integer

Указывает количество дней после создания, по истечении которых точка восстановления удаляется. Должно быть больше, чем 90 дней плюс rules.lifecycle.move_to_cold_storage_after_days.

move_to_cold_storage_after_days

integer

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

recovery_point_tags

dictionary

Для упорядочения ресурсов можно назначать собственные метаданные создаваемым ресурсам.

rule_name

string / required

Имя правила.

schedule_expression

string

Выражение CRON в UTC, указывающее, когда Backup инициирует задание резервного копирования. Если не указано, используется значение по умолчанию AWS.

Default: "cron(0 5 ? * * *)"

schedule_expression_timezone

string

added in amazon.aws 7.3.0

Это часовой пояс, в котором задано выражение расписания.

По умолчанию ScheduleExpressions задаются в UTC. Вы можете изменить это на указанный часовой пояс.

Для этого параметра требуется botocore >= 1.31.36.

Default: "Etc/UTC"

start_window_minutes

integer

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

Значение по умолчанию AWS, если не указано, равно 480.

Default: 480

target_backup_vault_name

string / обязательно

Имя хранилища резервных копий, на которое должна быть направлена эта правила.

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 для согласованности с AWS botocore SDK.

Псевдоним 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.

state

строка

Создать/обновить или удалить план резервного копирования.

Варианты:

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

tags

псевдонимы: resource_tags, backup_plan_tags

словарь

Для упорядочивания ресурсов вы можете назначить собственную метаданные создаваемым ресурсам. Каждый тег — это пара ключ-значение. Указанные теги назначаются всем резервным копиям, созданным с этим планом.

validate_certs

булево

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

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

Варианты:

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

backup_plan

dictionary

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

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

advanced_backup_settings

list / elements=dictionary

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

Возвращается: при настройке.

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

backup_options

dictionary

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

Возвращается: успешно

Пример: {"windows_vss": "enabled"}

resource_type

string

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

Возвращается: успешно

Пример: "EC2"

backup_plan_name

string

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

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

Пример: "elastic"

rules

list / elements=dictionary

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

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

completion_window_minutes

integer

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

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

Пример: 10080

copy_actions

list / elements=dictionary

Массив объектов 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

boolean

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

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

Пример: false

lifecycle

dictionary

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

Возвращается: при настройке.

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

recovery_point_tags

dictionary

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

Возвращается: при настройке.

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

rule_id

string

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

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

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

rule_name

string

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

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

Пример: "daily"

schedule_expression

string

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

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

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

schedule_expression_timezone

string

добавлено в amazon.aws 7.3.0

Это часовой пояс, в котором задано выражение расписания.

Эта информация возвращается для версий botocore >= 1.31.36.

Возвращается: когда botocore >= 1.31.36

Пример: "Etc/UTC"

start_window_minutes

integer

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

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

Пример: 480

target_backup_vault_name

string

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

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

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

tags

string

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

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

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

backup_plan_arn

string

ARN резервного плана.

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

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

backup_plan_id

string

ID резервного плана.

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

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

backup_plan_name

string

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

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

Пример: "elastic"

creation_date

string

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

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

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

deletion_date

string

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

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

Пример: "2023-05-05T16:24:51.987000-04:00"

exists

boolean

Существует ли ресурс.

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

Пример: true

version_id

string

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

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

Пример: "ODM3MjVjNjItYWFkOC00NjExLWIwZTYtZDNiNGI5M2I0ZTY1"