amazon.aws.rds_global_cluster_info module – Obtain information about Aurora global database clusters

Note

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

New in amazon.aws 7.0.0

Synopsis

  • Obtain information about Aurora global database clusters.

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.

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.

global_cluster_identifier

string

The user-supplied Global DB cluster identifier.

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

This parameter is not case-sensitive.

If supplied, must match an existing DBClusterIdentifier.

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

  • While developing this module, describe_global_cluster CLI did not yield any tag information.

  • Consequently, the “tags” parameter is not included in this module.

  • 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_global_cluster_info:
  register: _result_cluster_info

- name: Get info on a specific DB cluster
  amazon.aws.rds_global_cluster_info:
    global_cluster_identifier: "{{ cluster_id }}"
  register: _result_global_cluster_info

Return Values

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

Key

Description

global_clusters

list / elements=dictionary

List of global clusters.

Returned: always

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

engine

string

The database engine of the DB cluster.

Returned: success

Sample: "aurora-postgresql"

engine_version

string

The database engine version.

Returned: success

Sample: "14.8"

failover_state

dictionary

A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Aurora global database).

This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.

Returned: success

from_db_cluster_arn

string

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.

Returned: success

Sample: "arn:aws:rds:us-east-1:123456789012:cluster:ansible-test-primary"

is_data_loss_allowed

boolean

Indicates whether the operation is a global switchover or a global failover.

If data loss is allowed, then the operation is a global failover. Otherwise, it is a switchover.

Returned: success

Sample: false

status

string

The current status of the global cluster.

Returned: success

Sample: "pending"

to_db_cluster_arn

string

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.

Returned: success

Sample: "arn:aws:rds:us-east-2:123456789012:cluster:ansible-test-secondary"

gloabl_cluster_members

list / elements=dictionary

The list of primary and secondary clusters within the global database cluster.

Returned: success

db_cluster_arn

string

The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster.

Returned: success

Sample: "arn:aws:rds:us-east-1:123456789012:cluster:ansible-test-primary"

global_write_forwarding_status

string

The status of write forwarding for a secondary cluster in the global cluster.

Returned: success

Sample: "disabled"

is_writer

boolean

Indicates whether the Aurora DB cluster is the primary cluster for the global cluster with which it is associated.

Returned: success

Sample: false

readers

list / elements=string

The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the global cluster.

Returned: success

Sample: ["arn:aws:rds:us-east-2:123456789012:cluster:ansible-test-secondary"]

global_cluster_arn

string

The Amazon Resource Name (ARN) for the global database cluster.

Returned: success

Sample: "arn:aws:rds::xxx:global-cluster:ansible-test-global-cluster"

global_cluster_identifier

string

User-supplied global database cluster identifier.

Returned: success

Sample: "ansible-test-global-cluster"

global_cluster_resource_id

string

The Amazon Web Services Region-unique, immutable identifier for the global database cluster.

Returned: success

Sample: "cluster-xxx"

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

Authors

  • Gomathi Selvi Srinivasan (@GomathiselviS)