amazon.aws.backup_selection_info 模块 – 描述 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_info。

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_plan_name

别名：plan_name

字符串 / 必需

唯一标识要与资源选择关联的备份计划。

backup_selection_names

别名：selection_names

列表 / 元素=字符串

唯一标识应列出选择的备份计划。

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 端点以外的端点。虽然这可以用于连接到其他与 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 选项互斥。

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月1日后的版本中移除。

对EC2_REGION环境变量的支持已弃用，将在2024年12月1日后的版本中移除。

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月1日后的版本中移除。

对EC2_SECRET_KEY环境变量的支持已弃用，将在2024年12月1日后的版本中移除。

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月1日后的版本中移除。

对EC2_SECRET_KEY和AWS_SECURITY_TOKEN环境变量的支持已弃用，将在2024年12月1日后的版本中移除。

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。

示例

# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Gather information about all backup selections
  amazon.aws.backup_selection_info:
    backup_plan_name: "{{ backup_plan_name }}"

- name: Gather information about a particular backup selection
  amazon.aws.backup_selection_info:
    backup_plan_name: "{{ backup_plan_name }}"
    backup_selection_names:
      - "{{ backup_selection_name }}"

返回值

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

键

描述

backup_selections

列表 / 元素=字典

备份选择对象的列表。每个元素包含一个字典，其中包含与该备份选择相关的所有信息。

返回：始终

backup_plan_id

字符串

备份计划ID。

返回：始终

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

conditions

字典

使用标签将资源分配给备份计划时定义的条件列表（表示为字典）。

返回：始终

示例：{}

creation_date

字符串

备份计划创建时间。

返回：始终

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

iam_role_arn

字符串

IAM角色ARN。

返回：始终

示例："arn:aws:iam::111122223333:role/system-backup"

list_of_tags

列表 / 元素=字典

使用标签将资源分配给备份计划时定义的条件。

返回：始终

示例：[]

not_resources

列表 / 元素=字符串

从备份计划中排除的Amazon资源名称(ARN)列表。

返回：始终

示例：[]

resources

列表 / 元素=字符串

分配给备份计划的Amazon资源名称(ARN)列表。

返回：始终

示例：[]

selection_id

字符串

备份选择ID。

返回：始终

示例："1111c217-5d71-4a55-8728-5fc4e63d437b"

selection_name

字符串

备份选择名称。

返回：始终

示例："elastic"

作者

  • Gomathi Selvi Srinivasan (@GomathiselviS)

  • Kristof Imre Szabo (@krisek)

  • Alina Buzachis (@alinabuzachis)