Try SpotterObtain information about one or more RDS clusters
| "added in version" 3.2.0 of community.aws"
Authors: Alina Buzachis (@alinabuzachis)
Install with ansible-galaxy collection install community.aws:==4.3.0
collections:
- name: community.aws
version: 4.3.0Obtain information about one or more RDS clusters.
- name: Get info of all existing DB clusters community.aws.rds_cluster_info: register: _result_cluster_info
- name: Get info on a specific DB cluster
community.aws.rds_cluster_info:
cluster_id: "{{ cluster_id }}"
register: _result_cluster_info
- name: Get info all DB clusters with specific engine
community.aws.rds_cluster_info:
engine: "aurora"
register: _result_cluster_info
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION
environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_url
description:
- Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will
use EC2 endpoints). Ignored for modules where region is required. Must be specified
for all other modules if region is not used. If not set then the value of the EC2_URL
environment variable, if any, is used.
type: str
filters:
description:
- A filter that specifies one or more DB clusters to describe. See U(https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html).
type: dict
profile:
aliases:
- aws_profile
description:
- Uses a boto profile. Only works with boto >= 2.24.0.
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
- Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- Only used for boto3 based modules.
- 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
from the controller if not run locally.'
type: path
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY
or EC2_ACCESS_KEY environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY,
or EC2_SECRET_KEY environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
security_token:
aliases:
- aws_security_token
- access_token
description:
- AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN
environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
type: bool
db_cluster_identifier:
aliases:
- cluster_id
- id
- cluster_name
description:
- The user-supplied DB cluster identifier.
- If this parameter is specified, information from only the specific DB cluster is
returned.
type: str
debug_botocore_endpoint_logs:
default: 'no'
description:
- 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.
type: bool
clusters:
contains:
activity_stream_status:
description: The status of the database activity stream.
sample: stopped
type: str
allocated_storage:
description:
- The allocated storage size in gigabytes. Since aurora storage size is not
fixed this is always 1 for aurora database engines.
sample: 1
type: int
associated_roles:
description:
- 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.
sample: []
type: list
availability_zones:
description: The list of availability zones that instances in the DB cluster
can be created in.
sample:
- us-east-1c
- us-east-1a
- us-east-1e
type: list
backup_retention_period:
description: The number of days for which automatic DB snapshots are retained.
sample: 1
type: int
cluster_create_time:
description: The time in UTC when the DB cluster was created.
sample: '2018-06-29T14:08:58.491000+00:00'
type: str
copy_tags_to_snapshot:
description:
- Specifies whether tags are copied from the DB cluster to snapshots of the
DB cluster.
sample: false
type: bool
cross_account_clone:
description:
- Specifies whether the DB cluster is a clone of a DB cluster owned by a different
Amazon Web Services account.
sample: false
type: bool
db_cluster_arn:
description: The Amazon Resource Name (ARN) for the DB cluster.
sample: arn:aws:rds:us-east-1:123456789012:cluster:rds-cluster-demo
type: str
db_cluster_identifier:
description: The lowercase user-supplied DB cluster identifier.
sample: rds-cluster-demo
type: str
db_cluster_members:
description:
- A list of dictionaries containing information about the instances in the cluster.
Each dictionary contains the I(db_instance_identifier), I(is_cluster_writer)
(bool), I(db_cluster_parameter_group_status), and I(promotion_tier) (int).
sample: []
type: list
db_cluster_parameter_group:
description: The parameter group associated with the DB cluster.
sample: default.aurora5.6
type: str
db_cluster_resource_id:
description: The AWS Region-unique, immutable identifier for the DB cluster.
sample: cluster-D2MEQDN3BQNXDF74K6DQJTHASU
type: str
db_subnet_group:
description: The name of the subnet group associated with the DB Cluster.
sample: default
type: str
deletion_protection:
description:
- Indicates if the DB cluster has deletion protection enabled. The database
can't be deleted when deletion protection is enabled.
sample: false
type: bool
domain_memberships:
description:
- The Active Directory Domain membership records associated with the DB cluster.
sample: []
type: list
earliest_restorable_time:
description: The earliest time to which a database can be restored with point-in-time
restore.
sample: '2018-06-29T14:09:34.797000+00:00'
type: str
endpoint:
description: The connection endpoint for the primary instance of the DB cluster.
sample: rds-cluster-demo.cluster-cvlrtwiennww.us-east-1.rds.amazonaws.com
type: str
engine:
description: The database engine of the DB cluster.
sample: aurora
type: str
engine_mode:
description: The DB engine mode of the DB cluster.
sample: provisioned
type: str
engine_version:
description: The database engine version.
sample: 5.6.10a
type: str
hosted_zone_id:
description: The ID that Amazon Route 53 assigns when you create a hosted zone.
sample: Z2R2ITUGPM61AM
type: str
http_endpoint_enabled:
description:
- A value that indicates whether the HTTP endpoint for an Aurora Serverless
DB cluster is enabled.
sample: false
type: bool
iam_database_authentication_enabled:
description: Whether IAM accounts may be mapped to database accounts.
sample: false
type: bool
latest_restorable_time:
description: The latest time to which a database can be restored with point-in-time
restore.
sample: '2018-06-29T14:09:34.797000+00:00'
type: str
master_username:
description: The master username for the DB cluster.
sample: username
type: str
multi_az:
description: Whether the DB cluster has instances in multiple availability zones.
sample: false
type: bool
port:
description: The port that the database engine is listening on.
sample: 3306
type: int
preferred_backup_window:
description: The UTC weekly time range during which system maintenance can occur.
sample: 10:18-10:48
type: str
preferred_maintenance_window:
description: The UTC weekly time range during which system maintenance can occur.
sample: tue:03:23-tue:03:53
type: str
read_replica_identifiers:
description: A list of read replica ID strings associated with the DB cluster.
sample: []
type: list
reader_endpoint:
description: The reader endpoint for the DB cluster.
sample: rds-cluster-demo.cluster-ro-cvlrtwiennww.us-east-1.rds.amazonaws.com
type: str
status:
description: The status of the DB cluster.
sample: available
type: str
storage_encrypted:
description: Whether the DB cluster is storage encrypted.
sample: false
type: bool
tag_list:
description: A list of tags consisting of key-value pairs.
elements: dict
sample:
- key: Created_By
value: Ansible_rds_cluster_integration_test
type: list
tags:
description: A dictionary of key value pairs.
sample:
Name: rds-cluster-demo
type: dict
vpc_security_groups:
contains:
status:
description: Status of the security group.
sample: active
type: str
vpc_security_group_id:
description: Security group of the cluster.
sample: sg-12345678
type: str
description: A list of the DB cluster's security groups and their status.
type: complex
description: List of RDS clusters.
returned: always
type: list