community.aws.rds_snapshot_info module – obtain information about one or more RDS snapshots
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_snapshot_info
.
New in community.aws 1.0.0
Synopsis
Obtain information about one or more RDS snapshots. These can be for unclustered snapshots or snapshots of clustered DBs (Aurora).
Aurora snapshot information may be obtained if no identifier parameters are passed or if one of the cluster parameters are passed.
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. |
|
RDS cluster name for which to find snapshots. Mutually exclusive with db_snapshot_identifier, db_instance_identifier, db_cluster_snapshot_identifier |
|
Name of an RDS cluster snapshot. Mutually exclusive with db_instance_identifier, db_snapshot_identifier, db_cluster_identifier |
|
RDS instance name for which to find snapshots. Mutually exclusive with db_snapshot_identifier, db_cluster_identifier, db_cluster_snapshot_identifier |
|
Name of an RDS (unclustered) snapshot. Mutually exclusive with db_instance_identifier, db_cluster_identifier, db_cluster_snapshot_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. |
|
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. |
|
Type of snapshot to find. By default both automated and manual snapshots will be returned. Choices:
|
|
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 snapshot
community.aws.rds_snapshot_info:
db_snapshot_identifier: snapshot_name
register: new_database_info
- name: Get all RDS snapshots for an RDS instance
community.aws.rds_snapshot_info:
db_instance_identifier: helloworld-rds-master
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of cluster snapshots Returned: always |
|
How many gigabytes of storage are allocated Returned: always Sample: |
|
The availability zones of the database from which the snapshot was taken Returned: always Sample: |
|
Date and time the cluster was created Returned: always Sample: |
|
Database cluster identifier Returned: always Sample: |
|
ARN of the database snapshot Returned: always Sample: |
|
Snapshot identifier Returned: always Sample: |
|
Database engine Returned: always Sample: |
|
Database engine version Returned: always Sample: |
|
Whether database authentication through IAM is enabled Returned: always Sample: |
|
ID of the KMS Key encrypting the snapshot Returned: always Sample: |
|
License model Returned: always Sample: |
|
Database master username Returned: always Sample: |
|
Percent progress of snapshot Returned: always Sample: |
|
Database port Returned: always Sample: |
|
Date and time when the snapshot was created Returned: always Sample: |
|
Type of snapshot Returned: always Sample: |
|
Status of snapshot Returned: always Sample: |
|
Whether the snapshot is encrypted Returned: always Sample: |
|
Tags of the snapshot Returned: when snapshot is not shared |
|
VPC of the database Returned: always Sample: |
|
List of non-clustered snapshots Returned: When cluster parameters are not passed |
|
How many gigabytes of storage are allocated Returned: always Sample: |
|
The availability zone of the database from which the snapshot was taken Returned: always Sample: |
|
Database instance identifier Returned: always Sample: |
|
Snapshot ARN Returned: always Sample: |
|
Snapshot name Returned: always Sample: |
|
Whether the snapshot was encrypted Returned: always Sample: |
|
Database engine Returned: always Sample: |
|
Database engine version Returned: always Sample: |
|
Whether database authentication through IAM is enabled Returned: always Sample: |
|
Time the Instance was created Returned: always Sample: |
|
ID of the KMS Key encrypting the snapshot Returned: always Sample: |
|
License model Returned: always Sample: |
|
Database master username Returned: always Sample: |
|
Database option group name Returned: always Sample: |
|
Percent progress of snapshot Returned: always Sample: |
|
Time snapshot was created Returned: always Sample: |
|
Type of snapshot Returned: always Sample: |
|
Status of snapshot Returned: always Sample: |
|
Storage type of underlying DB Returned: always Sample: |
|
Snapshot tags Returned: when snapshot is not shared |
|
ID of VPC containing the DB Returned: always Sample: |