amazon.aws.backup_plan 模块 – 管理 AWS Backup 计划

注意

此模块是 amazon.aws 集合(版本 9.0.0)的一部分。

如果您正在使用 ansible 包,则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install amazon.aws。您需要进一步的要求才能使用此模块,请参阅要求了解详细信息。

要在 Playbook 中使用它,请指定:amazon.aws.backup_plan

amazon.aws 6.0.0 中的新功能

概要

要求

以下要求需要在执行此模块的主机上满足。

  • python >= 3.6

  • boto3 >= 1.28.0

  • botocore >= 1.31.0

参数

参数

注释

access_key

别名:aws_access_key_id, aws_access_key, ec2_access_key

字符串

AWS 访问密钥 ID。

有关访问令牌的更多信息,请参阅 AWS 文档:https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys

还可以按优先级降序使用 AWS_ACCESS_KEY_IDAWS_ACCESS_KEYEC2_ACCESS_KEY 环境变量。

aws_access_keyprofile 选项互斥。

为了与 AWS botocore SDK 保持一致,在 5.1.0 版本中添加了 aws_access_key_id 别名。

ec2_access_key 别名已被弃用,将在 2024-12-01 之后的版本中删除。

EC2_ACCESS_KEY 环境变量的支持已弃用,将在 2024-12-01 之后的版本中删除。

advanced_backup_settings

列表 / 元素=字典

指定每个资源类型的高级备份设置列表。

这些设置仅适用于 Windows 卷影复制服务 (VSS) 备份作业。

backup_options

字典

指定所选资源的备份选项。

此选项仅适用于 Windows VSS 备份作业。

WindowsVSS

字符串

启用或禁用 WindowsVSS 备份选项。

选择

  • “已启用”

  • “已禁用”

resource_type

字符串

指定包含资源类型和备份选项的对象。

唯一支持的资源类型是具有 Windows 卷影复制服务 (VSS) 的 Amazon EC2 实例。

选择

  • “EC2”

aws_ca_bundle

路径

用于验证 SSL 证书的 CA 包的位置。

还可以使用 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 回调来输出在 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_URLEC2_URL 环境变量。

ec2_urls3_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_keyaws_secret_keysecurity_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, ec2_region

字符串

要使用的 AWS 区域。

对于 IAM、Route53 和 CloudFront 等全局服务,将忽略 region

也可以使用 AWS_REGIONEC2_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

列表 / 元素=字典

BackupRule 对象的数组,每个对象都指定用于备份资源选择的计划任务。

state=present 时,此项为必填项。

completion_window_minutes

整数

备份作业成功启动后,必须在多少分钟内完成,否则将被 Backup 取消。

如果未提供,AWS 默认值为 10080

默认值: 10080

copy_actions

列表 / 元素=字典

copy_action 对象的数组,其中包含复制操作的详细信息。

destination_backup_vault_arn

字符串 / 必需

唯一标识复制备份的目标备份库的 Amazon 资源名称 (ARN)。

lifecycle

字典

包含 Transition 对象的数组,指定恢复点在多少天后转换为冷存储或被删除。

转换为冷存储的备份必须在冷存储中存储至少 90 天。因此,在控制台上,“保留期”设置必须比“转换为冷存储的天数”设置大 90 天。“转换为冷存储的天数”设置在备份转换为冷存储后无法更改。

delete_after_days

整数

指定恢复点在创建后多少天被删除。必须大于 90 天加上 rules.copy_actions.lifecycle.move_to_cold_storage_after_days

move_to_cold_storage_after_days

整数

指定恢复点在创建后多少天移动到冷存储。

enable_continuous_backup

布尔值

指定 Backup 是否创建连续备份。True 会导致 Backup 创建能够进行时间点还原 (PITR) 的连续备份。False(或未指定)会导致 Backup 创建快照备份。

如果未提供,AWS 默认值为 false

选择

  • false ←(默认)

  • true

lifecycle

字典

生命周期定义了受保护资源何时转换为冷存储以及何时过期。Backup 将根据您定义的生命周期自动转换和过期备份。

转换为冷存储的备份必须在冷存储中存储至少 90 天。因此,“保留期”设置必须比“转换为冷存储的天数”设置大 90 天。“转换为冷存储的天数”设置在备份转换为冷存储后无法更改。

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

字符串

一个 UTC 中的 CRON 表达式,指定 Backup 何时启动备份作业。如果未提供,则使用 AWS 默认值。

默认值: "cron(0 5 ? * * *)"

schedule_expression_timezone

字符串

在 amazon.aws 7.3.0 中添加

这是设置计划表达式的时区。

默认情况下,ScheduleExpressions 采用 UTC。您可以将其修改为指定的时区。

此选项需要 botocore >= 1.31.36。

默认值: "Etc/UTC"

start_window_minutes

整数

计划备份后多少分钟内,如果作业未成功启动,将被取消。如果包含此值,则必须至少为 60 分钟,以避免错误。

如果未提供,AWS 默认值为 480

默认值: 480

target_backup_vault_name

字符串 / 必需

此规则应定向的备份库的名称。

secret_key

别名:aws_secret_access_key, aws_secret_key, ec2_secret_key

字符串

AWS secret access key。

有关访问令牌的更多信息,请参阅 AWS 文档:https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys

也可以使用 AWS_SECRET_ACCESS_KEYAWS_SECRET_KEYEC2_SECRET_KEY 环境变量,优先级依次降低。

secret_keyprofile 选项互斥。

为了与 AWS botocore SDK 保持一致,在 5.1.0 版本中添加了 aws_secret_access_key 别名。

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_TOKENAWS_SECURITY_TOKENEC2_SECURITY_TOKEN 环境变量,优先级依次降低。

security_tokenprofile 选项互斥。

别名 aws_session_tokensession_token 在 3.2.0 版本中添加,该参数在 6.0.0 版本中从 security_token 重命名为 session_token

security_tokenaws_security_tokenaccess_token 别名已弃用,将在 2024-12-01 之后的版本中删除。

EC2_SECRET_KEYAWS_SECURITY_TOKEN 环境变量的支持已弃用,将在 2024-12-01 之后的版本中删除。

state

字符串

创建/更新或删除备份计划。

选择

  • "present" ←(默认)

  • "absent"

tags

别名:resource_tags, backup_plan_tags

字典

为了帮助您组织资源,您可以将自己的元数据分配给您创建的资源。每个标签都是一个键值对。指定的标签会分配给使用此计划创建的所有备份。

validate_certs

布尔值

当设置为 false 时,与 AWS API 通信时将不会验证 SSL 证书。

强烈建议不要设置 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

示例

- name: Create an AWSbackup plan
  amazon.aws.backup_plan:
    state: present
    backup_plan_name: elastic
    rules:
      - rule_name: daily
        advanced_backup_settings:
          - resource_type: "EC2"
            backup_options:
              WindowsVSS: enabled
        target_backup_vault_name: "{{ backup_vault_name }}"
        schedule_expression: 'cron(0 5 ? * * *)'
        start_window_minutes: 60
        completion_window_minutes: 1440
- name: Delete an AWS Backup plan
  amazon.aws.backup_plan:
    backup_plan_name: elastic
    state: absent

返回值

通用返回值记录在此处,以下是此模块特有的字段

描述

backup_plan

字典

备份计划详细信息。

返回: 在创建/更新时

advanced_backup_settings

列表 / 元素=字典

备份计划的高级备份设置。

返回: 配置后。

示例: [{"backup_options": {"windows_vss": "enabled"}, "resource_type": "EC2"}]

backup_options

字典

高级设置的备份选项。

返回: 成功

示例: {"windows_vss": "enabled"}

resource_type

字符串

高级设置的资源类型。

返回: 成功

示例: "EC2"

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

字符串

UTC 时区中的 cron 表达式,指定 Backup 何时启动备份作业。

返回: 始终

示例: "cron(0 5 ? * * *)"

schedule_expression_timezone

字符串

在 amazon.aws 7.3.0 中添加

这是设置计划表达式的时区。

此信息针对 botocore 版本 >= 1.31.36 返回。

返回: 当 botocore >= 1.31.36 时

示例: "Etc/UTC"

start_window_minutes

整数

在备份计划之后,如果作业没有成功启动,则在作业被取消之前的时间(以分钟为单位)。

返回: 始终

示例: 480

target_backup_vault_name

字符串

存储备份的逻辑容器的名称。

返回: 始终

示例: "09da67966fd5-backup-vault"

tags

字符串

备份计划的标签。

返回: 在创建/更新时

示例: "{'TagKey1': 'TagValue1', 'TagKey2': 'TagValue2'}"

backup_plan_arn

字符串

备份计划的 ARN。

返回: 始终

示例: "arn:aws:backup:eu-central-1:111122223333:backup-plan:1111f877-1ecf-4d79-9718-a861cd09df3b"

backup_plan_id

字符串

备份计划的 ID。

返回: 始终

示例: "1111f877-1ecf-4d79-9718-a861cd09df3b"

backup_plan_name

字符串

备份计划的名称。

返回: 始终

示例: "elastic"

creation_date

字符串

备份计划的创建日期。

返回: 在创建/更新时

示例: "2023-01-24T10:08:03.193000+01:00"

deletion_date

字符串

备份计划的删除日期。

返回: 在删除时

示例: "2023-05-05T16:24:51.987000-04:00"

exists

布尔值

资源是否存在。

返回: 始终

示例: true

version_id

字符串

备份计划的版本 ID。

返回: 始终

示例: "ODM3MjVjNjItYWFkOC00NjExLWIwZTYtZDNiNGI5M2I0ZTY1"

作者

  • Kristof Imre Szabo (@krisek)

  • Alina Buzachis (@alinabuzachis)

  • Helen Bailey (@hakbailey)