amazon.aws.backup_vault 模块 – 管理 AWS Backup Vaults

注意

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

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

要安装它，请使用：ansible-galaxy collection install amazon.aws。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在剧本中使用它，请指定：amazon.aws.backup_vault。

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_ID、AWS_ACCESS_KEY 或 EC2_ACCESS_KEY 环境变量，优先级依次递减。 aws_access_key 和 profile 选项是互斥的。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已弃用，将在 2024-12-01 后的某个版本中移除。 EC2_ACCESS_KEY 环境变量的支持已弃用，将在 2024-12-01 后的某个版本中移除。
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_vault_name 字符串 / 必需	备份存储库的名称。 名称对于用于创建它们的帐户和创建它们的 Amazon Web Services 区域是唯一的。 它们由字母、数字和连字符组成。
creator_request_id 字符串	一个唯一字符串，用于标识请求并允许重试失败的请求，而无需再次运行操作的风险。 如果使用，此参数必须包含 1 到 50 个字母数字字符或“-_.”字符。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 记录器来解析在任务期间进行的唯一（而不是全部）"resource:action" API 调用，并将该集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到剧本期间进行的全部列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
encryption_key_arn 字符串	用于保护备份的服务器端加密密钥。
endpoint_url 别名：ec2_url、aws_endpoint_url、s3_url 字符串	连接到非默认 AWS 端点的 URL。虽然这可以用于连接到其他与 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 别名：aws_region, ec2_region 字符串	要使用的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之后的一个版本中移除。
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 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_TOKEN、AWS_SECURITY_TOKEN或EC2_SECURITY_TOKEN环境变量。 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之后的一个版本中移除。 对EC2_SECRET_KEY和AWS_SECURITY_TOKEN环境变量的支持已弃用，并将在2024-12-01之后的一个版本中移除。
state 字符串	添加或删除备份保管库配置。 选项 "present" ← (默认) "absent"
tags 别名：resource_tags 字典	表示要应用于资源的标签的字典。 如果未设置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 backup vault
  amazon.aws.backup_vault:
    state: present
    backup_vault_name: default-vault
    encryption_key_arn: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    tags:
      environment: dev
      Name: default

返回值

常见的返回值已在 此处记录，以下是此模块特有的字段

键	描述
exists 布尔值	备份保管库是否存在。 返回：始终 示例：true
vault 复杂	备份保管库详细信息。 返回：始终 示例："hash/dictionary of values"
backup_vault_arn 字符串	唯一标识备份保管库的Amazon资源名称(ARN)。 返回：始终 示例："arn:aws:backup:us-east-1:123456789012:vault:aBackupVault"
backup_vault_name 字符串	存储备份的逻辑容器的名称。 返回：始终 示例："default-name"
creation_date 字符串	创建备份保管库的日期和时间，采用Unix格式和协调世界时(UTC)。 返回：始终 示例："2024-05-21T13:21:10.062000-07:00"
encryption_key_arn 字符串	用于保护备份的服务器端加密密钥。 返回：始终 示例："arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
locked 布尔值	一个布尔值，指示备份保管库锁定是否正在保护备份保管库。 True表示保管库锁定会导致对存储在保管库中的恢复点的删除或更新操作失败。 返回：始终 示例：false
number_of_recovery_points 整数	存储在备份保管库中的恢复点数量。 返回：始终 示例：0
tags 字符串	备份保管库的标签。 返回：在创建/更新时 示例："{'TagKey1': 'TagValue1', 'TagKey2': 'TagValue2'}"

作者

• Gomathi Selvi Srinivasan (@GomathiselviS)

资源链接

• 问题追踪器
• 代码仓库
• 沟通