amazon.aws.backup_selection 模块 – 创建、删除和修改 AWS Backup 选择

注意

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

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

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

要在 playbook 中使用它，请指定：amazon.aws.backup_selection。

amazon.aws 6.0.0 中的新增功能

概要

• 管理 AWS Backup 选择。

• 有关更多信息，请参阅 AWS 关于备份选择的文档 https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html。

要求

执行此模块的主机需要以下要求。

• 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_plan_name 别名：plan_name 字符串 / 必需	唯一标识要与资源选择关联的备份计划。
backup_selection_name 别名：selection_name 字符串 / 必需	资源选择文档的显示名称。必须包含 1 到 50 个字母数字或“-_.”字符。
conditions 字典	您定义的条件列表（表示为字典），用于使用标签将资源分配到您的备份计划。 当您在 conditions 中指定多个条件时，您只分配匹配所有条件的资源（使用 AND 逻辑）。 conditions 支持 string_equals、string_like、string_not_equals 和 string_not_like。list_of_tags 只支持 string_equals。
string_equals 列表 / 元素=字典	筛选已标记资源的值，仅限于您使用相同值标记的那些资源。 默认值： []
condition_key 字符串	键值对中的键。 conditions.string_equals.condition_key 在 conditions 选项中必须使用 AWS 资源标签前缀，例如“aws:ResourceTag/key-name”
condition_value 字符串	键值对中的值。
string_like 列表 / 元素=字典	使用通配符字符 (*) 在字符串中的任何位置筛选已标记资源的值，以匹配标记值。例如，“prod*”或“*rod*”匹配标记值“production”。 默认值： []
condition_key 字符串	键值对中的键。 conditions.string_like.condition_key 在 conditions 选项中必须使用 AWS 资源标签前缀，例如 ‘aws:ResourceTag/key-name’
condition_value 字符串	键值对中的值。
string_not_equals 列表 / 元素=字典	筛选已标记资源的值，仅保留那些标记值不相同的资源。 默认值： []
condition_key 字符串	键值对中的键。 conditions.string_not_equals.condition_key 在 conditions 选项中必须使用 AWS 资源标签前缀，例如 ‘aws:ResourceTag/key-name’
condition_value 字符串	键值对中的值。
string_not_like 列表 / 元素=字典	使用通配符 (*) 筛选标记资源的值，过滤与模式不匹配的标签值。 默认值： []
condition_key 字符串	键值对中的键。 conditions.string_not_like.condition_key 在 conditions 选项中必须使用 AWS 资源标签前缀，例如 ‘aws:ResourceTag/key-name’
condition_value 字符串	键值对中的值。
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 字符串	连接到非默认 AWS 端点的 URL。虽然这可以用于连接到其他兼容 AWS 的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 也可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次递减。 ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的发行版中删除。 对 EC2_URL 环境变量的支持已弃用，将在 2024-12-01 之后的发行版中删除。
iam_role_arn 字符串	Backup 用于在备份目标资源时进行身份验证的 IAM 角色的 ARN。
list_of_tags 列表 / 元素=字典	您定义的一组条件，用于使用标签将资源分配到您的备份计划。 条件运算符区分大小写。 当您在 list_of_tags 中指定多个条件时，您将分配匹配至少一个条件的所有资源（使用 OR 逻辑）。
condition_key 字符串	键值对中的键。
condition_type 字符串	应用于键值对的操作，用于将资源分配到您的备份计划。 条件仅支持 STRINGEQUALS。
condition_value 字符串	键值对中的值。
not_resources 列表 / 元素=字符串	要从备份计划中排除的 Amazon 资源名称 (ARN) 列表。不使用通配符时，最多可以有 500 个 ARN，使用通配符时最多可以有 30 个 ARN。如果您需要从备份计划中排除许多资源，请考虑使用不同的资源选择策略，例如只分配一种或几种资源类型，或者使用标签细化资源选择。
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 选项互斥。
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 之后的发行版中删除。
resources 列表 / 元素=字符串	要分配到备份计划的 Amazon 资源名称 (ARN) 列表。不使用通配符时，最多可以有 500 个 ARN，使用通配符时最多可以有 30 个 ARN。如果您需要将许多资源分配到备份计划，请考虑使用不同的资源选择策略，例如分配资源类型的所有资源，或者使用标签细化资源选择。
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"
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 selection
  amazon.aws.backup_selection:
    selection_name: elastic
    backup_plan_name: test-backup-plan
    iam_role_arn: arn:aws:iam::111122223333:role/system-backup
    resources:
      - arn:aws:elasticfilesystem:*:*:file-system/*

- name: Create backup selection, assign resources using tags
  amazon.aws.backup_selection:
    selection_name: elastic
    backup_plan_name: test-backup-plan
    iam_role_arn: arn:aws:iam::111122223333:role/system-backup
    list_of_tags:
      - condition_type: STRINGEQUALS
        condition_key: Owner
        condition_value: Dev01

返回值

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

键	描述
backup_selection 复杂类型	备份选择详细信息。 返回：始终返回
backup_plan_id 字符串	备份计划的 ID。 返回：始终返回 示例："1111f877-1ecf-4d79-9718-a861cd09df3b"
conditions 字典	定义如何使用标签将资源分配到备份计划的一组条件。 返回：始终返回 示例： {"string_equals": [], "string_like": [], "string_not_equals": [], "string_not_like": []}
string_equals 列表 / 元素=字符串	仅筛选具有相同标记值的标记资源的值。 返回：始终返回 示例： []
string_like 列表 / 元素=字符串	使用通配符 (*) 在字符串中的任何位置匹配标记值来筛选标记资源的值。 返回：始终返回 示例： []
string_not_equals 列表 / 元素=字符串	仅筛选不具有相同标记值的标记资源的值。 返回：始终返回 示例： []
string_not_like 列表 / 元素=字符串	使用通配符 (*) 在字符串中的任何位置匹配标记值来筛选不匹配的标记资源的值。 返回：始终返回 示例： []
creation_date 字符串	备份计划的创建时间。 返回值：在创建/更新时 示例： "2023-01-24T10:08:03.193000+01:00"
iam_role_arn 字符串	Backup 用于在备份目标资源时进行身份验证的 IAM 角色的 ARN。 返回：始终返回 示例： "arn:aws:iam::111122223333:role/system-backup"
list_of_tags 列表 / 元素=字典	使用标签将资源分配到备份计划的定义条件。 返回：始终返回 示例： [{"condition_key": "Environment", "condition_type": "STRINGEQUALS", "condition_value": "Dev"}]
condition_key 字符串	键值对中的键。 返回：始终返回 示例： "Environment"
condition_type 字符串	应用于键值对的操作，用于将资源分配到备份计划。 返回：始终返回 示例： "STRINGEQUALS"
condition_value 字符串	键值对中的值。 返回：始终返回 示例： "Dev"
not_resources 列表 / 元素=字符串	从备份计划中排除的 Amazon 资源名称 (ARN) 列表。 返回：始终返回 示例： []
resources 列表 / 元素=字符串	分配到备份计划的 Amazon 资源名称 (ARN) 列表。 返回：始终返回 示例： []
selection_id 字符串	备份选择 ID。 返回：始终返回 示例： "1111c217-5d71-4a55-8728-5fc4e63d437b"
selection_name 字符串	资源选择文档的显示名称。 返回：始终返回 示例： "elastic"

作者

• Kristof Imre Szabo (@krisek)

• Alina Buzachis (@alinabuzachis)

资源链接

• 问题追踪器
• 代码库 (源代码)
• 沟通