community.aws.redshift_info 模块 – 收集有关 Redshift 集群的信息

注意

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

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

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

要在 playbook 中使用它，请指定： community.aws.redshift_info。

community.aws 1.0.0 中的新增功能

概要 

收集有关 Redshift 集群的信息。

要求 

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

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。
cluster_identifier 别名：name, identifier 字符串	您正在搜索的 Redshift 集群的集群标识符前缀。这是一个带有隐式 ‘^’ 的正则表达式匹配。追加 ‘$’ 以进行完全匹配。
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 之后的版本中删除。
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 保持一致，aws_secret_access_key 别名已在 5.1.0 版本中添加。 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 之后的版本中移除。
tags 字典	以 { tag1_name: ‘tag1_value’, tag2_name: ‘tag2_value’ } 格式表示的标签字典/哈希，用于匹配您正在搜索的安全组。
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 net set authentication details, see the AWS guide for details.

- name: Find all clusters
  community.aws.redshift_info:
  register: redshift

- name: Find cluster(s) with matching tags
  community.aws.redshift_info:
    tags:
      env: prd
      stack: monitoring
  register: redshift_tags

- name: Find cluster(s) with matching name/prefix and tags
  community.aws.redshift_info:
    tags:
      env: dev
      stack: web
    name: user-
  register: redshift_web

- name: Fail if no cluster(s) is/are found
  community.aws.redshift_info:
    tags:
      env: stg
      stack: db
  register: redshift_user
  failed_when: "{{ redshift_user.results | length == 0 }}"

返回值 

通用返回值记录在此处，以下是此模块独有的字段

键	描述
allow_version_upgrade 布尔值	一个布尔值，如果为 true，则表示在维护窗口期间，主要版本升级将自动应用于集群。返回: 成功示例: `"true\|false"`
automated_snapshot_retention_period 整数	自动集群快照保留的天数。返回: 成功示例: `1`
availability_zone 字符串	集群所在的可用区名称。返回: 成功示例: `"us-east-1b"`
cluster_create_time 字符串	创建集群的日期和时间。返回: 成功示例: `"2016-05-10T08:33:16.629000+00:00"`
cluster_identifier 字符串	用于标识集群的唯一键。返回: 成功示例: `"redshift-identifier"`
cluster_nodes 列表 / 元素=字符串	集群中的节点。返回: 成功示例: `[{"node_role": "LEADER", "private_ip_address": "10.0.0.1", "public_ip_address": "x.x.x.x"}, {"node_role": "COMPUTE-1", "private_ip_address": "10.0.0.3", "public_ip_address": "x.x.x.x"}]`
cluster_paramater_groups 列表 / 元素=字符串	与此集群关联的集群参数列表。返回: 成功示例: `[{"cluster_parameter_status_list": [{"parameter_apply_status": "in-sync", "parameter_name": "statement_timeout"}, {"parameter_apply_status": "in-sync", "parameter_name": "require_ssl"}], "parameter_apply_status": "in-sync", "parameter_group_name": "tuba"}]`
cluster_public_keys 字符串	集群的公钥。返回: 成功示例: `"ssh-rsa anjigfam Amazon-Redshift\n"`
cluster_revision_number 字符串	集群中数据库的特定修订号。返回: 成功示例: `"1231"`
cluster_security_groups 列表 / 元素=字符串	与集群关联的集群安全组列表。返回: 成功示例: `[]`
cluster_snapshot_copy_status 字典	返回为跨区域快照复制配置的目标区域和保留期的值。返回: 成功示例: `{}`
cluster_status 字符串	集群的当前状态。返回: 成功示例: `"available"`
cluster_subnet_group_name 字符串	与集群关联的子网组的名称。返回: 成功示例: `"redshift-subnet"`
cluster_version 字符串	集群上运行的 Amazon Redshift 引擎的版本 ID。返回: 成功示例: `"1.0"`
db_name 字符串	创建集群时创建的初始数据库的名称。返回: 成功示例: `"dev"`
elastic_ip_status 字典	弹性 IP (EIP) 地址的状态。返回: 成功示例: `{}`
encrypted 布尔值	布尔值，如果为 true，则表示集群中的数据在静态时加密。返回: 成功示例: `"true\|false"`
endpoint 字符串	连接端点。返回: 成功示例: `"{'address': 'cluster-ds2.ocmugla0rf.us-east-1.redshift.amazonaws.com', 'port': 5439}"`
enhanced_vpc_routing 布尔值	一个选项，用于指定是否在启用增强型 VPC 路由的情况下创建集群。返回: 成功示例: `"true\|false"`
hsm_status 字典	一个值，报告 Amazon Redshift 集群是否已完成应用在修改集群命令中指定的任何硬件安全模块 (HSM) 设置更改。返回: 成功示例: `{}`
iam_roles 列表 / 元素=字符串	附加到集群的 IAM 角色列表。返回: 成功示例: `[]`
kms_key_id 字符串	用于加密集群中数据的加密密钥的 AWS Key Management Service (AWS KMS) 密钥 ID。返回: 成功示例: `""`
master_username 字符串	集群的主用户名。返回: 成功示例: `"admin"`
modify_status 字符串	修改操作的状态。返回: 可选示例: `""`
node_type 字符串	集群中节点的节点类型。返回: 成功示例: `"ds2.xlarge"`
number_of_nodes 整数	集群中计算节点的数量。返回: 成功示例: `12`
pending_modified_values 字典	一个值，如果存在，则表示集群的更改正在等待中。返回: 成功示例: `{}`
preferred_maintenance_window 字符串	每周时间范围（采用协调世界时 (UTC)），在此期间可以进行系统维护。返回: 成功示例: `"tue:07:30-tue:08:00"`
publicly_accessible 布尔值	一个布尔值，如果为 true，则表示可以从公共网络访问该集群。返回: 成功示例: `"true\|false"`
restore_status 字典	描述集群还原操作状态的值。返回: 成功示例: `{}`
tags 列表 / 元素=字符串	集群的标签列表。返回: 成功示例: `[]`
vpc_id 字符串	集群所在的 VPC 的标识符（如果集群位于 VPC 中）。返回: 成功示例: `"vpc-1234567"`
vpc_security_groups 列表 / 元素=字符串	与集群关联的 VPC 安全组列表。返回: 成功示例: `[{"status": "active", "vpc_security_group_id": "sg-12cghhg"}]`

作者

Jens Carl (@j-carl)