Модуль amazon.aws.backup_plan – Управление планами AWS Backup

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.

advanced_backup_settings

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

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

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

backup_options

словарь

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

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

WindowsVSS

строка

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

Варианты:

• "enabled"
• "disabled"

resource_type

строка

Задаёт объект с типом ресурса и параметрами резервного копирования.

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

Варианты:

• "EC2"

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_name

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

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

Отображаемое имя плана резервного копирования. Должно содержать от 1 до 50 буквенно-цифровых символов или символов «-_.».

creator_request_id

строка

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

debug_botocore_endpoint_logs

логический

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

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.

rules

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

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

Обязательный параметр, если state=present.

completion_window_minutes

целое число

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

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

По умолчанию: 10080

copy_actions

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

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

destination_backup_vault_arn

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

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

lifecycle

словарь

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

Резервные копии, перемещённые в холодное хранилище, должны храниться там не менее 90 дней. Поэтому в консоли значение параметра «retention» должно быть на 90 дней больше значения параметра «transition to cold after days». Значение параметра «transition to cold after days» нельзя изменить после перемещения резервной копии в холодное хранилище.

delete_after_days

целое число

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

move_to_cold_storage_after_days

целое число

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

enable_continuous_backup

логический

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

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

Варианты:

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

lifecycle

словарь

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

Резервные копии, перемещённые в холодное хранилище, должны храниться там не менее 90 дней. Поэтому значение параметра «retention» должно быть на 90 дней больше значения параметра «transition to cold after days». Значение параметра «transition to cold after days» нельзя изменить после перемещения резервной копии в холодное хранилище.

delete_after_days

целое число

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

move_to_cold_storage_after_days

целое число

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

recovery_point_tags

словарь

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

rule_name

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

Имя правила.

schedule_expression

строка

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

По умолчанию: "cron(0 5 ? * * *)"

schedule_expression_timezone

строка

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

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

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

По умолчанию: "Etc/UTC"

start_window_minutes

целое число

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

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

По умолчанию: 480

target_backup_vault_name

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

Имя хранилища Backup, для которого предназначено это правило.

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, backup_plan_tags

словарь

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

validate_certs

логический

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

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

Варианты:

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

backup_plan

dictionary

Сведения о плане резервного копирования.

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

advanced_backup_settings

list / элементы=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 / элементы=dictionary

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

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

completion_window_minutes

integer

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

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

Пример: 10080

copy_actions

list / элементы=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

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

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

Пример: "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

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

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

Пример: "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"