amazon.aws.backup_plan_info 模块 – 描述 AWS 备份计划
注意
此模块是 amazon.aws 集合 (版本 9.0.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.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 之后的一个版本中移除。
|
|
验证 SSL 证书时要使用的 CA 证书包的位置。 还可以使用 |
|
用于修改 botocore 配置的字典。 可以在 AWS 文档中找到参数 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。 |
|
指定计划名称列表。 |
|
使用 还可以使用 选项
|
|
连接到的 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。 ec2_region 别名已弃用，并将在 2024-12-01 之后的一个版本中移除。
|
|
AWS 密钥。 有关访问令牌的更多信息，请参阅 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 选项互斥。 在 3.2.0 版本中添加了 aws_session_token 和 session_token 别名，在 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。
示例
# 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
返回值
常见的返回值已在 此处 记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
备份计划对象的列表。列表元素是包含备份计划信息的字典。 返回：始终 |
|
备份计划的详细信息。 返回：始终 |
|
备份计划的高级备份设置。 返回：已配置时 示例： |
|
高级设置的选项。 返回：成功 |
|
高级设置的资源类型。 返回：成功 |
|
备份计划的名称。 返回：始终 示例： |
|
BackupRule 对象数组，每个对象指定用于备份所选资源的计划任务。 返回：始终 |
|
备份作业成功启动后，必须完成之前以分钟为单位的值，否则Backup将取消该作业。 返回：始终 示例： |
|
CopyAction 对象数组，其中包含复制操作的详细信息。 返回：已配置时。 示例： |
|
指定 Backup 是否创建持续备份。 返回：始终 示例： |
|
定义受保护的资源何时转换为冷存储以及何时过期。 返回：已配置时。 示例： |
|
从备份恢复时分配给与此规则关联的资源的键值对字符串数组。 返回：已配置时。 示例： |
|
唯一标识用于安排所选资源备份的规则。 返回：始终 示例： |
|
备份规则的显示名称。 返回：始终 示例： |
|
指定 Backup 何时启动备份作业的 UTC 时间的 cron 表达式。 返回：始终 示例： |
|
计划备份后，如果作业未成功启动，则在几分钟后取消作业的值。 返回：始终 示例： |
|
存储备份的逻辑容器的名称。 返回：始终 示例： |
|
唯一标识备份计划的 Amazon 资源名称 (ARN)。 返回：始终 示例： |
|
备份计划的 ID。 返回：始终 示例： |
|
备份计划的显示名称。 返回：始终 示例： |
|
备份计划的创建日期。 返回：始终 示例： |
|
备份计划的上次执行日期。 返回：始终 示例： |
|
备份计划的标签 返回：始终 示例： |
|
备份计划的版本 ID 返回：始终 示例： |