amazon.aws.rds_cluster_info module – Obtain information about one or more RDS clusters

Note

This module is part of the amazon.aws collection (version 7.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_info.

New in amazon.aws 5.0.0

Synopsis

  • Obtain information about one or more RDS clusters.

  • This module was originally added to community.aws in release 3.2.0.

Requirements

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

  • python >= 3.6

  • boto3 >= 1.26.0

  • botocore >= 1.29.0

Parameters

Parameter

Comments

access_key

aliases: aws_access_key_id, aws_access_key, ec2_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, AWS_ACCESS_KEY or EC2_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.

The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

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_cluster_identifier

aliases: cluster_id, id, cluster_name

string

The user-supplied DB cluster identifier.

If this parameter is specified, information from only the specific DB cluster is returned.

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: ec2_url, aws_endpoint_url, s3_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 or EC2_URL environment variables may also be used, in decreasing order of preference.

The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.

filters

dictionary

A filter that specifies one or more DB clusters to describe. See https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html.

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 security_token options.

region

aliases: aws_region, ec2_region

string

The AWS region to use.

For global services such as IAM, Route53 and CloudFront, region is ignored.

The AWS_REGION or EC2_REGION environment variables may also be used.

See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01

Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_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, AWS_SECRET_KEY, or EC2_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.

The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_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, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference.

The security_token and profile options are mutually exclusive.

Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0.

The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.

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: Get info of all existing DB clusters
  amazon.aws.rds_cluster_info:
  register: _result_cluster_info

- name: Get info on a specific DB cluster
  amazon.aws.rds_cluster_info:
    cluster_id: "{{ cluster_id }}"
  register: _result_cluster_info

- name: Get info all DB clusters with specific engine
  amazon.aws.rds_cluster_info:
    engine: "aurora"
  register: _result_cluster_info

Return Values

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

Key

Description

clusters

list / elements=string

List of RDS clusters.

Returned: always

activity_stream_status

string

The status of the database activity stream.

Returned: success

Sample: "stopped"

allocated_storage

integer

The allocated storage size in gigabytes. Since aurora storage size is not fixed this is always 1 for aurora database engines.

Returned: success

Sample: 1

associated_roles

list / elements=string

A list of dictionaries of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. Each dictionary contains the role_arn and the status of the role.

Returned: success

Sample: []

availability_zones

list / elements=string

The list of availability zones that instances in the DB cluster can be created in.

Returned: success

Sample: ["us-east-1c", "us-east-1a", "us-east-1e"]

backup_retention_period

integer

The number of days for which automatic DB snapshots are retained.

Returned: success

Sample: 1

cluster_create_time

string

The time in UTC when the DB cluster was created.

Returned: success

Sample: "2018-06-29T14:08:58.491000+00:00"

copy_tags_to_snapshot

boolean

Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

Returned: success

Sample: false

cross_account_clone

boolean

Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

Returned: success

Sample: false

db_cluster_arn

string

The Amazon Resource Name (ARN) for the DB cluster.

Returned: success

Sample: "arn:aws:rds:us-east-1:123456789012:cluster:rds-cluster-demo"

db_cluster_identifier

string

The lowercase user-supplied DB cluster identifier.

Returned: success

Sample: "rds-cluster-demo"

db_cluster_members

list / elements=string

A list of dictionaries containing information about the instances in the cluster. Each dictionary contains the db_instance_identifier, is_cluster_writer (bool), db_cluster_parameter_group_status, and promotion_tier (int).

Returned: success

Sample: []

db_cluster_parameter_group

string

The parameter group associated with the DB cluster.

Returned: success

Sample: "default.aurora5.6"

db_cluster_resource_id

string

The AWS Region-unique, immutable identifier for the DB cluster.

Returned: success

Sample: "cluster-D2MEQDN3BQNXDF74K6DQJTHASU"

db_subnet_group

string

The name of the subnet group associated with the DB Cluster.

Returned: success

Sample: "default"

deletion_protection

boolean

Indicates if the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled.

Returned: success

Sample: false

domain_memberships

list / elements=string

The Active Directory Domain membership records associated with the DB cluster.

Returned: success

Sample: []

earliest_restorable_time

string

The earliest time to which a database can be restored with point-in-time restore.

Returned: success

Sample: "2018-06-29T14:09:34.797000+00:00"

endpoint

string

The connection endpoint for the primary instance of the DB cluster.

Returned: success

Sample: "rds-cluster-demo.cluster-cvlrtwiennww.us-east-1.rds.amazonaws.com"

engine

string

The database engine of the DB cluster.

Returned: success

Sample: "aurora"

engine_mode

string

The DB engine mode of the DB cluster.

Returned: success

Sample: "provisioned"

engine_version

string

The database engine version.

Returned: success

Sample: "5.6.10a"

hosted_zone_id

string

The ID that Amazon Route 53 assigns when you create a hosted zone.

Returned: success

Sample: "Z2R2ITUGPM61AM"

http_endpoint_enabled

boolean

A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

Returned: success

Sample: false

iam_database_authentication_enabled

boolean

Whether IAM accounts may be mapped to database accounts.

Returned: success

Sample: false

latest_restorable_time

string

The latest time to which a database can be restored with point-in-time restore.

Returned: success

Sample: "2018-06-29T14:09:34.797000+00:00"

master_username

string

The master username for the DB cluster.

Returned: success

Sample: "username"

multi_az

boolean

Whether the DB cluster has instances in multiple availability zones.

Returned: success

Sample: false

port

integer

The port that the database engine is listening on.

Returned: success

Sample: 3306

preferred_backup_window

string

The UTC weekly time range during which system maintenance can occur.

Returned: success

Sample: "10:18-10:48"

preferred_maintenance_window

string

The UTC weekly time range during which system maintenance can occur.

Returned: success

Sample: "tue:03:23-tue:03:53"

read_replica_identifiers

list / elements=string

A list of read replica ID strings associated with the DB cluster.

Returned: success

Sample: []

reader_endpoint

string

The reader endpoint for the DB cluster.

Returned: success

Sample: "rds-cluster-demo.cluster-ro-cvlrtwiennww.us-east-1.rds.amazonaws.com"

status

string

The status of the DB cluster.

Returned: success

Sample: "available"

storage_encrypted

boolean

Whether the DB cluster is storage encrypted.

Returned: success

Sample: false

tag_list

list / elements=dictionary

A list of tags consisting of key-value pairs.

Returned: success

Sample: [{"key": "Created_By", "value": "Ansible_rds_cluster_integration_test"}]

tags

dictionary

A dictionary of key value pairs.

Returned: success

Sample: {"Name": "rds-cluster-demo"}

vpc_security_groups

complex

A list of the DB cluster’s security groups and their status.

Returned: success

status

string

Status of the security group.

Returned: success

Sample: "active"

vpc_security_group_id

string

Security group of the cluster.

Returned: success

Sample: "sg-12345678"

Authors

  • Alina Buzachis (@alinabuzachis)