amazon.aws.rds_global_cluster_info 模块 – 获取关于 Aurora 全局数据库集群的信息

注意

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

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

要安装它，请使用：ansible-galaxy collection install amazon.aws。您需要进一步的要求才能使用此模块，请参阅 要求 获取详细信息。

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

amazon.aws 7.0.0 中的新增功能

概要

• 获取关于 Aurora 全局数据库集群的信息。

要求

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

• 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。
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 字符串	要连接到的 URL，而不是默认的 AWS 端点。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 也可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次降低。 ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_URL 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
global_cluster_identifier 字符串	用户提供的全局数据库集群标识符。 如果指定了此参数，则仅返回来自特定数据库集群的信息。 此参数不区分大小写。 如果提供，则必须与现有的 DBClusterIdentifier 匹配。
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 之后的版本中移除。
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 选项是互斥的。 别名 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 之后的版本中移除。 对 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中移除。
validate_certs 布尔值	设置为 false 时，与 AWS API 通信时将不验证 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)

说明

注意

• 在开发此模块时，describe_global_cluster CLI 没有产生任何标签信息。

• 因此，此模块中不包含 “tags” 参数。

• 注意： 对于模块，环境变量和配置文件是从 Ansible 'host' 上下文读取，而不是从 'controller' 上下文读取。 因此，可能需要将文件显式复制到 'host'。 对于查找和连接插件，环境变量和配置文件是从 Ansible 'controller' 上下文读取，而不是从 'host' 上下文读取。

• Ansible 使用的 AWS SDK (boto3) 也可能从 Ansible 'host' 上下文中的配置文件（通常是 ~/.aws/credentials）读取凭据和其他设置（例如区域）的默认值。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例

- name: Get info of all existing DB clusters
  amazon.aws.rds_global_cluster_info:
  register: _result_cluster_info

- name: Get info on a specific DB cluster
  amazon.aws.rds_global_cluster_info:
    global_cluster_identifier: "{{ cluster_id }}"
  register: _result_global_cluster_info

返回值

常见的返回值记录在这里，以下是此模块独有的字段

键	描述
global_clusters 列表 / 元素=字典	全局集群列表。 返回: 总是
deletion_protection 布尔值	指示是否启用了数据库集群的删除保护。启用删除保护时，无法删除数据库。 返回: 总是 示例: false
engine 字符串	数据库集群的数据库引擎。 返回: 总是 示例: "aurora-postgresql"
engine_version 字符串	数据库引擎版本。 返回: 总是 示例: "14.8"
failover_state 字典	一个数据对象，包含此全局集群（Aurora 全局数据库）的正在进行或等待切换或故障转移过程的当前状态的所有属性。 除非在此全局集群上调用了 SwitchoverGlobalCluster 或 FailoverGlobalCluster 操作，否则此对象为空。 返回: 成功
from_db_cluster_arn 字符串	当前正在降级的 Aurora 数据库集群的 Amazon 资源名称 (ARN)，与此状态相关联。 返回: 总是 示例: "arn:aws:rds:us-east-1:123456789012:cluster:ansible-test-primary"
is_data_loss_allowed 布尔值	指示该操作是全局切换还是全局故障转移。 如果允许数据丢失，则该操作是全局故障转移。否则，它是切换。 返回: 总是 示例: false
status 字符串	全局集群的当前状态。 返回: 总是 示例: "pending"
to_db_cluster_arn 字符串	当前正在升级的 Aurora 数据库集群的 Amazon 资源名称 (ARN)，与此状态相关联。 返回: 总是 示例: "arn:aws:rds:us-east-2:123456789012:cluster:ansible-test-secondary"
gloabl_cluster_members 列表 / 元素=字典	全局数据库集群内的主要和次要集群的列表。 返回: 成功
db_cluster_arn 字符串	全局集群中每个 Aurora 数据库集群的 Amazon 资源名称 (ARN)。 返回: 总是 示例: "arn:aws:rds:us-east-1:123456789012:cluster:ansible-test-primary"
global_write_forwarding_status 字符串	全局集群中辅助集群的写入转发状态。 返回: 总是 示例: "disabled"
is_writer 布尔值	指示 Aurora 数据库集群是否是与其关联的全局集群的主集群。 返回: 总是 示例: false
readers 列表 / 元素=字符串	与全局集群关联的每个只读辅助集群的 Amazon 资源名称 (ARN)。 返回: 总是 示例: ["arn:aws:rds:us-east-2:123456789012:cluster:ansible-test-secondary"]
global_cluster_arn 字符串	全局数据库集群的 Amazon 资源名称 (ARN)。 返回: 总是 示例: "arn:aws:rds::123456789012:global-cluster:ansible-test-global-cluster"
global_cluster_identifier 字符串	用户提供的全局数据库集群标识符。 返回: 成功 示例: "ansible-test-global-cluster"
global_cluster_resource_id 字符串	全局数据库集群的 Amazon Web Services 区域唯一、不可变的标识符。 返回: 总是 示例: "cluster-123456789012"
status 字符串	数据库集群的状态。 返回: 总是 示例: "available"
storage_encrypted 布尔值	数据库集群是否已进行存储加密。 返回: 总是 示例: false

作者

• Gomathi Selvi Srinivasan (@GomathiselviS)

集合链接

• 问题跟踪器
• 存储库（来源）
• 沟通