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 8.2.1).
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 |
---|---|
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 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 |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
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. |
|
Use a The Choices:
|
|
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 The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
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. |
|
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 The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
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 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 |
|
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 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 |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
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 |
---|---|
List of global clusters. Returned: always |
|
Indicates if the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. Returned: always Sample: |
|
The database engine of the DB cluster. Returned: always Sample: |
|
The database engine version. Returned: always Sample: |
|
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 |
|
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state. Returned: always Sample: |
|
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: always Sample: |
|
The current status of the global cluster. Returned: always Sample: |
|
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state. Returned: always Sample: |
|
The list of primary and secondary clusters within the global database cluster. Returned: success |
|
The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster. Returned: always Sample: |
|
The status of write forwarding for a secondary cluster in the global cluster. Returned: always Sample: |
|
Indicates whether the Aurora DB cluster is the primary cluster for the global cluster with which it is associated. Returned: always Sample: |
|
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the global cluster. Returned: always Sample: |
|
The Amazon Resource Name (ARN) for the global database cluster. Returned: always Sample: |
|
User-supplied global database cluster identifier. Returned: success Sample: |
|
The Amazon Web Services Region-unique, immutable identifier for the global database cluster. Returned: always Sample: |
|
The status of the DB cluster. Returned: always Sample: |
|
Whether the DB cluster is storage encrypted. Returned: always Sample: |