amazon.aws.rds_cluster_param_group 模块 – 管理 RDS 集群参数组

注意

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

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

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

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

amazon.aws 7.6.0 中的新增功能

概要

• 创建、修改和删除 RDS 集群参数组。

要求

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

• 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。
db_parameter_group_family 字符串	RDS 集群参数组系列名称。 一个 RDS 集群参数组只能与一个 RDS 集群参数组系列关联，并且只能应用于运行与该 RDS 集群参数组系列兼容的数据库引擎和引擎版本的 RDS 集群。 请使用 amazon.aws.rds_engine_versions_info 模块列出数据库引擎的所有可用参数组系列。 RDS 集群参数组系列是不可变的，并且在更新 RDS 集群参数组时无法更改。请参阅 https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html state=present 时必需。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 记录器来解析任务期间进行的唯一（而不是总计）"resource:action" API 调用，将该集合输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调来输出 playbook 期间生成的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
description 字符串	RDS 集群参数组的描述。 state=present 时必需。
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 之后的版本中删除。
name 字符串 / 必需	要创建、修改或删除的 RDS 集群参数组的名称。
parameters 列表 / 元素=字典	要更新的参数列表。
apply_method 字符串 / 必需	指示何时应用参数更新。 选项 "立即" "等待重启"
参数名称 字符串 / 必需	指定参数的名称。
参数值 字符串 / 必需	指定参数的值。
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 选项互斥。
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 secret access key。 有关访问令牌的更多信息，请参阅 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 之后的版本中删除。
state 字符串	指定 RDS 集群参数组应该是 present 还是 absent。 选项 "present" ← (默认) "absent"
tags 别名: resource_tags 字典	一个字典，表示要应用于资源的标签。 如果未设置 tags 参数，则不会修改标签。
validate_certs 布尔值	设置为 false 时，与 AWS API 通信时将不验证 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)

注释

注意

• 注意： 对于模块，环境变量和配置文件是从 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: Add or change a parameter group, in this case setting authentication_timeout to 200
  amazon.aws.rds_cluster_param_group:
      state: present
      name: test-cluster-group
      description: 'My test RDS cluster group'
      db_parameter_group_family: 'mysql5.6'
      parameters:
          - parameter_name: authentication_timeout
            parameter_value: "200"
            apply_method: immediate
      tags:
          Environment: production
          Application: parrot

- name: Remove a parameter group
  amazon.aws.rds_param_group:
      state: absent
      name: test-cluster-group

返回值

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

键	描述
db_cluster_parameter_group 复杂	包含所有 RDS 集群参数组信息的字典。 返回: 成功
db_cluster_parameter_group_arn 字符串	RDS 集群参数组的 Amazon 资源名称 (ARN)。 返回: 当 state=present 时 示例: "arn:aws:rds:us-west-2:123456789012:cluster-pg:ansible-test-123456789012-redhat-cluster-param-group"
db_cluster_parameter_group_name 字符串	RDS 集群参数组的名称。 返回: 当 state=present 时 示例: "ansible-test-123456789012-redhat-cluster-param-group"
db_parameter_group_family 字符串	此 RDS 集群参数组与之兼容的 RDS 参数组系列的名称。 返回: 当 state=present 时 示例: "postgres16"
description 字符串	提供此 RDS 集群参数组的客户指定描述。 返回: 当 state=present 时 示例: "RDS 集群 参数 组"
tags 字典	一个标签字典。 返回: 当 state=present 时 示例: {"another": "tag", "resource_prefix": "ansible-test-53268383-redhat", "some": "tag"}

作者

• Aubin Bikouo (@abikouo)

集合链接

• 问题跟踪器
• 存储库（源代码）
• 通信