community.aws.rds_instance_info module – obtain information about one or more RDS instances
Note
This module is part of the community.aws collection (version 3.6.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 community.aws
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.aws.rds_instance_info
.
New in community.aws 1.0.0
Synopsis
Obtain information about one or more RDS instances.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.16.0
botocore >= 1.19.0
Parameters
Parameter |
Comments |
---|---|
If profile is set this parameter is ignored. Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. |
|
The location of a CA Bundle to use when validating SSL certificates. Not used by boto 2 based modules. Note: The CA Bundle is read ‘module’ side and may need to be explicitly copied from the controller if not run locally. |
|
A dictionary to modify the botocore configuration. Parameters can be found at 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 http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration. |
|
If profile is set this parameter is ignored. Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. |
|
The RDS instance’s unique identifier. |
|
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:
|
|
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. |
|
A filter that specifies one or more DB instances to describe. See https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html |
|
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated. aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01. |
|
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 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region |
|
If profile is set this parameter is ignored. Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. Aliases aws_session_token and session_token have been added in version 3.2.0. |
|
When set to “no”, SSL certificates will not be validated for communication with the AWS APIs. Choices:
|
Notes
Note
If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URL
orEC2_URL
,AWS_PROFILE
orAWS_DEFAULT_PROFILE
,AWS_ACCESS_KEY_ID
orAWS_ACCESS_KEY
orEC2_ACCESS_KEY
,AWS_SECRET_ACCESS_KEY
orAWS_SECRET_KEY
orEC2_SECRET_KEY
,AWS_SECURITY_TOKEN
orEC2_SECURITY_TOKEN
,AWS_REGION
orEC2_REGION
,AWS_CA_BUNDLE
When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically
~/.aws/credentials
). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
AWS_REGION
orEC2_REGION
can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
Examples
- name: Get information about an instance
community.aws.rds_instance_info:
db_instance_identifier: new-database
register: new_database_info
- name: Get all RDS instances
community.aws.rds_instance_info:
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of RDS instances Returned: always |
|
Gigabytes of storage allocated to the database Returned: always Sample: |
|
Whether minor version upgrades happen automatically Returned: always Sample: |
|
Availability Zone in which the database resides Returned: always Sample: |
|
Days for which backups are retained Returned: always Sample: |
|
ID for the CA certificate Returned: always Sample: |
|
Whether DB tags should be copied to the snapshot Returned: always Sample: |
|
ARN of the database instance Returned: always Sample: |
|
Instance class of the database instance Returned: always Sample: |
|
Database instance identifier Returned: always Sample: |
|
Port used by the database instance Returned: always Sample: |
|
Status of the database instance Returned: always Sample: |
|
Name of the database Returned: always Sample: |
|
List of database parameter groups Returned: always |
|
Name of the database parameter group Returned: always Sample: |
|
Whether the parameter group has been applied Returned: always Sample: |
|
List of security groups used by the database instance Returned: always Sample: |
|
list of subnet groups Returned: always |
|
Description of the DB subnet group Returned: always Sample: |
|
Name of the database subnet group Returned: always Sample: |
|
Subnet group status Returned: always Sample: |
|
List of subnets in the subnet group Returned: always |
|
Availability zone of the subnet Returned: always |
|
Name of the availability zone Returned: always Sample: |
|
Subnet ID Returned: always Sample: |
|
Subnet status Returned: always Sample: |
|
VPC id of the subnet group Returned: always Sample: |
|
AWS Region-unique, immutable identifier for the DB instance Returned: always Sample: |
|
Returned: always Sample: |
|
List of domain memberships Returned: always Sample: |
|
Database endpoint Returned: always |
|
Database endpoint address Returned: always Sample: |
|
Route53 hosted zone ID Returned: always Sample: |
|
Database endpoint port Returned: always Sample: |
|
Database engine Returned: always Sample: |
|
Database engine version Returned: always Sample: |
|
Whether database authentication through IAM is enabled Returned: always Sample: |
|
Date and time the instance was created Returned: always Sample: |
|
The Provisioned IOPS value for the DB instance. Returned: always Sample: |
|
KMS Key ID Returned: always Sample: |
|
Latest time to which a database can be restored with point-in-time restore Returned: always Sample: |
|
License model Returned: always Sample: |
|
Database master username Returned: always Sample: |
|
Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance Returned: always Sample: |
|
Whether Multi-AZ is on Returned: always Sample: |
|
List of option groups Returned: always |
|
Option group name Returned: always Sample: |
|
Status of option group Returned: always Sample: |
|
Modified values pending application Returned: always |
|
Whether performance insights are enabled Returned: always Sample: |
|
Preferred backup window Returned: always Sample: |
|
Preferred maintenance window Returned: always Sample: |
|
Whether the DB is publicly accessible Returned: always Sample: |
|
List of database instance read replicas Returned: always Sample: |
|
Whether the storage is encrypted Returned: always Sample: |
|
Storage type of the Database instance Returned: always Sample: |
|
Tags used by the database instance Returned: always |
|
List of VPC security groups Returned: always |
|
Status of the VPC security group Returned: always Sample: |
|
VPC Security Group ID Returned: always Sample: |