community.aws.redshift 模块 – 创建、删除或修改 Amazon Redshift 实例

注意

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

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

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

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

community.aws 1.0.0 中的新增功能

概要

• 创建、删除或修改 Amazon 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 之后的版本中删除。
allow_version_upgrade 别名：version_upgrade 布尔值	当 allow_version_upgrade=true 时，集群可能会在维护窗口期间自动升级。 选项 false true ← (默认)
automated_snapshot_retention_period 别名：retention_period 整数	自动快照保留的天数。
availability_zone 别名：zone，aws_zone 字符串	在其中启动集群的可用区。
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_parameter_group_name 别名：param_group_name 字符串	集群参数组的名称。
cluster_security_groups 别名：security_groups 列表 / 元素=字符串	集群所属的安全组。
cluster_subnet_group_name 别名：subnet 字符串	放置集群的子网。
cluster_type 字符串	集群的类型。 选项 "多节点" "单节点" ← (默认)
cluster_version 别名：version 字符串	集群应具有的版本。 选项 "1.0"
command 字符串 / 必需	指定要执行的操作。 选项 "创建" "facts" "删除" "修改"
db_name 字符串	数据库的名称。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 记录器来解析任务期间进行的唯一（而不是总计）"resource:action" API 调用，并将集合输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调输出到 playbook 期间的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
elastic_ip 字符串	用于集群的弹性 IP。
encrypted 布尔值	集群是否加密。 选项 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 之后的版本中删除。
enhanced_vpc_routing 布尔值	是否启用增强型 VPC 路由的集群。 选项 false ← (默认) true
final_cluster_snapshot_identifier 别名: final_snapshot_id 字符串	在删除集群之前要创建的最终快照的标识符。 如果提供了此参数，skip_final_cluster_snapshot 必须为 false。 仅当 command=delete 时使用。
identifier 字符串 / 必需	Redshift 集群标识符。
new_cluster_identifier 别名: new_identifier 字符串	仅当 command=modify 时使用。
node_type 字符串	集群的节点类型。 当 command=create 时需要。 选项 "ds1.xlarge" "ds1.8xlarge" "ds2.xlarge" "ds2.8xlarge" "dc1.large" "dc2.large" "dc1.8xlarge" "dw1.xlarge" "dw1.8xlarge" "dw2.large" "dw2.8xlarge"
number_of_nodes 整数	节点数量。 仅当 cluster_type=multi-node 时使用。
password 字符串	主数据库密码。 仅当 command=create 时使用。
port 整数	集群正在监听的端口。
preferred_maintenance_window 别名: maintance_window, maint_window 字符串	维护窗口格式为 ddd:hh24:mi-ddd:hh24:mi。（例如：Mon:22:00-Mon:23:15） 时间以 UTC 为单位指定。 如果未指定，则会分配一个随机的 30 分钟维护窗口。
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 选项互斥。
publicly_accessible 布尔值	集群是否可公开访问。 选项 false ← (默认) true
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_secret_access_key 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 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 之后的版本中删除。
skip_final_cluster_snapshot 别名: skip_final_snapshot 布尔值	在删除集群之前跳过最终快照。 仅当 command=delete 时使用。 选项 false ← (默认) true
tags 别名: resource_tags 字典	一个字典，表示要应用于资源的标签。 如果未设置 tags 参数，则不会修改标签。
username 字符串	主数据库用户名。 仅当 command=create 时使用。
validate_certs 布尔值	当设置为 false 时，与 AWS API 通信时将不验证 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)
vpc_security_group_ids 别名: vpc_security_groups 列表 / 元素=字符串	VPC 安全组
wait 布尔值	当 command=create、command=modify 或 command=restore 时，等待数据库进入“可用”状态。 当 command=delete 时，等待数据库终止。 选项 false ← (默认) true
wait_timeout 整数	当 wait=true 时，定义放弃前的等待秒数。 默认值: 300

注释

注意

• 对 tags 和 purge_tags 的支持在 1.3.0 版本中添加。

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

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

示例

- name: Basic cluster provisioning example
  community.aws.redshift:
    command: create
    node_type: ds1.xlarge
    identifier: new_cluster
    username: cluster_admin
    password: 1nsecure

- name: Cluster delete example
  community.aws.redshift:
    command: delete
    identifier: new_cluster
    skip_final_cluster_snapshot: true
    wait: true

返回值

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

键	描述
cluster 复杂	包含所有集群信息的字典 已返回: 成功
availability_zone 字符串	集群所在的 Amazon 可用区。在集群可用之前为“None”。 已返回: 成功 示例: "us-east-1b"
create_time 浮点数	集群创建时间的时间戳。 已返回: 成功 示例: 1430158536.308
db_name 字符串	数据库的名称。 已返回: 成功 示例: "new_db_name"
enhanced_vpc_routing 布尔值	增强型 vpc 路由功能的状态。 已返回: 成功
identifier 字符串	集群的 ID。 已返回: 成功 示例: "new_redshift_cluster"
maintenance_window 字符串	进行维护/升级的时间范围。 已返回: 成功 示例: "sun:09:30-sun:10:00"
port 整数	集群的端口。在集群可用之前为“None”。 已返回: 成功 示例: 5439
private_ip_address 字符串	主节点的私有 IP 地址。 已返回: 成功 示例: "10.10.10.10"
public_ip_address 字符串	主节点的公共 IP 地址。启用 enhanced_vpc_routing 时为“None”。 已返回: 成功 示例: "0.0.0.0"
status 字符串	集群的状态。 已返回: 成功 示例: "available"
tags 字典	集群的 aws 标签。 已返回: 成功
url 字符串	主集群节点的 FQDN。在集群可用之前为“None”。 已返回: 成功 示例: "new-redshift_cluster.jfkdjfdkj.us-east-1.redshift.amazonaws.com"

作者

• Jens Carl (@j-carl)，Hothead Games Inc.

• Rafael Driutti (@rafaeldriutti)

集合链接

• 问题跟踪器
• 仓库 (源代码)
• 通信