amazon.aws.rds_cluster_param_group module – Manage RDS cluster parameter groups

Note

This module is part of the amazon.aws collection (version 11.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install amazon.aws. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: amazon.aws.rds_cluster_param_group.

New in amazon.aws 7.6.0

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

Creates, modifies, and deletes RDS cluster parameter groups.

Requirements

The below requirements are needed on the host that executes this module.

python >= 3.6
boto3 >= 1.35.0
botocore >= 1.35.0

Parameters

Parameter	Comments
access_key aliases: aws_access_key_id, aws_access_key string	AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The `AWS_ACCESS_KEY_ID` or `AWS_ACCESS_KEY` environment variables may also be used in decreasing order of preference. The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK.
aws_ca_bundle path	The location of a CA Bundle to use when validating SSL certificates. The `AWS_CA_BUNDLE` environment variable may also be used.
aws_config dictionary	A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
db_parameter_group_family string	The RDS cluster parameter group family name. An RDS cluster parameter group can be associated with one and only one RDS cluster parameter group family, and can be applied only to a RDS cluster running a database engine and engine version compatible with that RDS cluster parameter group family. Please use amazon.aws.rds_engine_versions_info module To list all of the available parameter group families for a DB engine. The RDS cluster parameter group family is immutable and can’t be changed when updating a RDS cluster parameter group. See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html Required for `state=present`.
debug_botocore_endpoint_logs boolean	Use a `botocore.endpoint` logger to parse the unique (rather than total) `"resource:action"` API calls made during a task, outputing the set to the resource_actions key in the task results. Use the `aws_resource_action` callback to output to total list made during a playbook. The `ANSIBLE_DEBUG_BOTOCORE_LOGS` environment variable may also be used. Choices: `false` ← (default) `true`
description string	The description for the RDS cluster parameter group. Required for `state=present`.
endpoint_url aliases: aws_endpoint_url string	URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The `AWS_URL` environment variable may also be used.
name string / required	The name of the RDS cluster parameter group to create, modify or delete.
parameters list / elements=dictionary	A list of parameters to update.
apply_method string / required	Indicates when to apply parameter updates. Choices: `"immediate"` `"pending-reboot"`
parameter_name string / required	Specifies the name of the parameter.
parameter_value string / required	Specifies the value of the parameter.
profile aliases: aws_profile string	A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The `AWS_PROFILE` environment variable may also be used. The profile option is mutually exclusive with the aws_access_key, aws_secret_key and session_token options.
purge_tags boolean	If `purge_tags=true` and `tags` is set, existing tags will be purged from the resource to match exactly what is defined by `tags` parameter. If the `tags` parameter is not set then tags will not be modified, even if `purge_tags=True`. Tag keys beginning with `aws:` are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the `purge_tags` parameter. See the Amazon documentation for more information https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions. Choices: `false` `true` ← (default)
region aliases: aws_region string	The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The `AWS_REGION` environment variable may also be used. See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
secret_key aliases: aws_secret_access_key, aws_secret_key string	AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The `AWS_SECRET_ACCESS_KEY` or `AWS_SECRET_KEY` environment variables may also be used in decreasing order of preference. The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK.
session_token aliases: aws_session_token string	AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The `AWS_SESSION_TOKEN` environment variable may also be used. The session_token and profile options are mutually exclusive.
state string	Specifies whether the RDS cluster parameter group should be present or absent. Choices: `"present"` ← (default) `"absent"`
tags aliases: resource_tags dictionary	A dictionary representing the tags to be applied to the resource. If the `tags` parameter is not set then tags will not be modified.
validate_certs boolean	When set to `false`, SSL certificates will not be validated for communication with the AWS APIs. Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices: `false` `true` ← (default)

Notes

Note

Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

Examples

- 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_cluster_param_group:
      state: absent
      name: test-cluster-group

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
db_cluster_parameter_group complex	dictionary containing all the RDS cluster parameter group information. Returned: success
db_cluster_parameter_group_arn string	The Amazon Resource Name (ARN) for the RDS cluster parameter group. Returned: when `state=present` Sample: `"arn:aws:rds:us-west-2:123456789012:cluster-pg:ansible-test-123456789012-redhat-cluster-param-group"`
db_cluster_parameter_group_name string	The name of the RDS cluster parameter group. Returned: when `state=present` Sample: `"ansible-test-123456789012-redhat-cluster-param-group"`
db_parameter_group_family string	The name of the RDS parameter group family that this RDS cluster parameter group is compatible with. Returned: when `state=present` Sample: `"postgres16"`
description string	Provides the customer-specified description for this RDS cluster parameter group. Returned: when `state=present` Sample: `"RDS cluster param group"`
tags dictionary	A dictionary of tags. Returned: when `state=present` Sample: `{"another": "tag", "resource_prefix": "ansible-test-53268383-redhat", "some": "tag"}`

Authors

Aubin Bikouo (@abikouo)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/rds_cluster_param_group_module.html