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 中的新功能
概要
创建、更新或删除 AWS Backup 计划。
有关更多信息,请参阅 AWS 文档中有关 Backup 计划的说明:https://docs.aws.amazon.com/aws-backup/latest/devguide/about-backup-plans.html。
要求
以下要求需要在执行此模块的主机上满足。
python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.0
参数
参数 |
注释 |
---|---|
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 和 profile 选项互斥。 为了与 AWS botocore SDK 保持一致,在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已被弃用,将在 2024-12-01 之后的版本中删除。 对 |
|
指定每个资源类型的高级备份设置列表。 这些设置仅适用于 Windows 卷影复制服务 (VSS) 备份作业。 |
|
指定所选资源的备份选项。 此选项仅适用于 Windows VSS 备份作业。 |
|
启用或禁用 WindowsVSS 备份选项。 选择
|
|
指定包含资源类型和备份选项的对象。 唯一支持的资源类型是具有 Windows 卷影复制服务 (VSS) 的 Amazon EC2 实例。 选择
|
|
用于验证 SSL 证书的 CA 包的位置。 还可以使用 |
|
用于修改 botocore 配置的字典。 参数可以在 AWS 文档中找到:https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。 |
|
备份计划的显示名称。必须包含 1 到 50 个字母数字或 ‘-_.’ 字符。 |
|
标识请求,并允许重试失败的请求,而不会冒重复运行操作的风险。如果请求包含与现有备份计划匹配的 CreatorRequestId,则返回该计划。 |
|
使用 还可以使用 选择
|
|
要连接到的 URL,而不是默认的 AWS 端点。虽然这可以用于连接到其他 AWS 兼容服务,但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 还可以按优先级降序使用 ec2_url 和 s3_url 别名已被弃用,将在 2024-12-01 之后的版本中删除。 对 |
|
用于身份验证的命名 AWS 配置文件。 有关命名配置文件的更多信息,请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 也可以使用 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。 |
|
如果 如果未设置 以 选择
|
|
要使用的 AWS 区域。 对于 IAM、Route53 和 CloudFront 等全局服务,将忽略 region。 也可以使用 有关更多信息,请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。
对 |
|
BackupRule 对象的数组,每个对象都指定用于备份资源选择的计划任务。 当 |
|
备份作业成功启动后,必须在多少分钟内完成,否则将被 Backup 取消。 如果未提供,AWS 默认值为 默认值: |
|
copy_action 对象的数组,其中包含复制操作的详细信息。 |
|
唯一标识复制备份的目标备份库的 Amazon 资源名称 (ARN)。 |
|
包含 Transition 对象的数组,指定恢复点在多少天后转换为冷存储或被删除。 转换为冷存储的备份必须在冷存储中存储至少 90 天。因此,在控制台上,“保留期”设置必须比“转换为冷存储的天数”设置大 90 天。“转换为冷存储的天数”设置在备份转换为冷存储后无法更改。 |
|
指定恢复点在创建后多少天被删除。必须大于 |
|
指定恢复点在创建后多少天移动到冷存储。 |
|
指定 Backup 是否创建连续备份。True 会导致 Backup 创建能够进行时间点还原 (PITR) 的连续备份。False(或未指定)会导致 Backup 创建快照备份。 如果未提供,AWS 默认值为 选择
|
|
生命周期定义了受保护资源何时转换为冷存储以及何时过期。Backup 将根据您定义的生命周期自动转换和过期备份。 转换为冷存储的备份必须在冷存储中存储至少 90 天。因此,“保留期”设置必须比“转换为冷存储的天数”设置大 90 天。“转换为冷存储的天数”设置在备份转换为冷存储后无法更改。 |
|
指定恢复点在创建后多少天被删除。必须大于 |
|
指定恢复点在创建后多少天移动到冷存储。 |
|
为了帮助您组织资源,您可以将自己的元数据分配给您创建的资源。 |
|
规则的名称。 |
|
一个 UTC 中的 CRON 表达式,指定 Backup 何时启动备份作业。如果未提供,则使用 AWS 默认值。 默认值: |
|
这是设置计划表达式的时区。 默认情况下,ScheduleExpressions 采用 UTC。您可以将其修改为指定的时区。 此选项需要 botocore >= 1.31.36。 默认值: |
|
计划备份后多少分钟内,如果作业未成功启动,将被取消。如果包含此值,则必须至少为 60 分钟,以避免错误。 如果未提供,AWS 默认值为 默认值: |
|
此规则应定向的备份库的名称。 |
|
AWS secret access key。 有关访问令牌的更多信息,请参阅 AWS 文档:https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 secret_key 和 profile 选项互斥。 为了与 AWS botocore SDK 保持一致,在 5.1.0 版本中添加了 aws_secret_access_key 别名。 ec2_secret_key 别名已弃用,将在 2024-12-01 之后的版本中删除。 对 |
|
用于临时凭证的 AWS STS 会话令牌。 有关访问令牌的更多信息,请参阅 AWS 文档:https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 security_token 和 profile 选项互斥。 别名 aws_session_token 和 session_token 在 3.2.0 版本中添加,该参数在 6.0.0 版本中从 security_token 重命名为 session_token。 security_token、aws_security_token 和 access_token 别名已弃用,将在 2024-12-01 之后的版本中删除。 对 |
|
创建/更新或删除备份计划。 选择
|
|
为了帮助您组织资源,您可以将自己的元数据分配给您创建的资源。每个标签都是一个键值对。指定的标签会分配给使用此计划创建的所有备份。 |
|
当设置为 强烈建议不要设置 validate_certs=false,作为替代方案,请考虑设置 aws_ca_bundle。 选择
|
注意
注意
警告: 对于模块,环境变量和配置文件是从 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
返回值
通用返回值记录在此处,以下是此模块特有的字段
键 |
描述 |
---|---|
备份计划详细信息。 返回: 在创建/更新时 |
|
备份计划的高级备份设置。 返回: 配置后。 示例: |
|
高级设置的备份选项。 返回: 成功 示例: |
|
高级设置的资源类型。 返回: 成功 示例: |
|
备份计划的显示名称。 返回: 始终 示例: |
|
BackupRule 对象的数组,每个对象都指定用于备份资源选择的计划任务。 返回: 始终 |
|
备份作业成功启动后,必须在多少分钟内完成,否则将被 Backup 取消。 返回: 始终 示例: |
|
CopyAction 对象的数组,其中包含复制操作的详细信息。 返回: 配置后。 示例: |
|
指定 Backup 是否创建连续备份。 返回: 始终 示例: |
|
定义受保护的资源何时转换为冷存储以及何时过期。 返回: 配置后。 示例: |
|
键值对字符串的数组,这些字符串在从备份还原时分配给与此规则关联的资源。 返回: 配置后。 示例: |
|
唯一标识用于安排选择资源备份的规则。 返回: 始终 示例: |
|
备份规则的显示名称。 返回: 始终 示例: |
|
UTC 时区中的 cron 表达式,指定 Backup 何时启动备份作业。 返回: 始终 示例: |
|
这是设置计划表达式的时区。 此信息针对 botocore 版本 >= 1.31.36 返回。 返回: 当 botocore >= 1.31.36 时 示例: |
|
在备份计划之后,如果作业没有成功启动,则在作业被取消之前的时间(以分钟为单位)。 返回: 始终 示例: |
|
存储备份的逻辑容器的名称。 返回: 始终 示例: |
|
备份计划的标签。 返回: 在创建/更新时 示例: |
|
备份计划的 ARN。 返回: 始终 示例: |
|
备份计划的 ID。 返回: 始终 示例: |
|
备份计划的名称。 返回: 始终 示例: |
|
备份计划的创建日期。 返回: 在创建/更新时 示例: |
|
备份计划的删除日期。 返回: 在删除时 示例: |
|
资源是否存在。 返回: 始终 示例: |
|
备份计划的版本 ID。 返回: 始终 示例: |