amazon.aws.rds_cluster_param_group_info module – Describes the properties of specific RDS cluster parameter group

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_info.

New in amazon.aws 7.6.0

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

Obtain information about a list or one specific RDS cluster parameter group.

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.
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`
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.
include_parameters string	Specifies whether to include the detailed parameters of the RDS cluster parameter group. `all` include all parameters. `engine-default` include engine-default parameters. `system` include system parameters. `user` include user parameters. Choices: `"all"` `"engine-default"` `"system"` `"user"`
name string	The RDS cluster parameter group name.
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.
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.
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: Describe a specific RDS cluster parameter group
  amazon.aws.rds_cluster_param_group_info:
    name: myrdsclustergroup

- name: Describe all RDS cluster parameter group
  amazon.aws.rds_cluster_param_group_info:

- name: Describe a specific RDS cluster parameter group including user parameters
  amazon.aws.rds_cluster_param_group_info:
    name: myrdsclustergroup
    include_parameters: user

Return Values

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

Key	Description
db_cluster_parameter_groups list / elements=string	List of RDS cluster parameter groups. Returned: always
db_cluster_parameter_group_arn string	The Amazon Resource Name (ARN) for the RDS cluster parameter group. Returned: success
db_cluster_parameter_group_name string	The name of the RDS cluster parameter group. Returned: success
db_parameter_group_family string	The name of the RDS parameter group family that this RDS cluster parameter group is compatible with. Returned: success
db_parameters list / elements=dictionary	Provides a list of parameters for the RDS cluster parameter group. Returned: When `include_parameters` is set Sample: `[{"allowed_values": "1-600", "apply_method": "pending-reboot", "apply_type": "dynamic", "data_type": "integer", "description": "(s) Sets the maximum allowed time to complete client authentication.", "is_modifiable": true, "parameter_name": "authentication_timeout", "parameter_value": "100", "source": "user", "supported_engine_modes": ["provisioned"]}]`
description string	Provides the customer-specified description for this RDS cluster parameter group. Returned: success
tags dictionary	A dictionary of key value pairs. Returned: success Sample: `{"Name": "rds-cluster-demo"}`

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_info_module.html