community.aws.rds_instance_snapshot module – Manage Amazon RDS instance 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_instance_snapshot
.
New in community.aws 1.0.0
Synopsis
Creates or deletes RDS snapshots.
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. |
|
Whether to copy all tags from source_db_snapshot_identifier to db_instance_identifier. Choices:
|
|
Database instance identifier. Required when creating a snapshot. |
|
The snapshot to manage. |
|
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. |
|
whether to remove tags not present in the tags parameter. Choices:
|
|
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. |
|
The identifier of the source DB snapshot. Required when copying a snapshot. If the source snapshot is in the same AWS region as the copy, specify the snapshot’s identifier. If the source snapshot is in a different AWS region as the copy, specify the snapshot’s ARN. |
|
The region that contains the snapshot to be copied. |
|
Specify the desired state of the snapshot. Choices:
|
|
tags dict to apply to a snapshot. |
|
When set to “no”, SSL certificates will not be validated for communication with the AWS APIs. Choices:
|
|
Whether or not to wait for snapshot creation or deletion. Choices:
|
|
how long before wait gives up, in seconds. Default: |
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: Create snapshot
community.aws.rds_instance_snapshot:
db_instance_identifier: new-database
db_snapshot_identifier: new-database-snapshot
register: snapshot
- name: Copy snapshot from a different region and copy its tags
community.aws.rds_instance_snapshot:
id: new-database-snapshot-copy
region: us-east-1
source_id: "{{ snapshot.db_snapshot_arn }}"
source_region: us-east-2
copy_tags: yes
- name: Delete snapshot
community.aws.rds_instance_snapshot:
db_snapshot_identifier: new-database-snapshot
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
How much storage is allocated in GB. Returned: always Sample: |
|
Availability zone of the database from which the snapshot was created. Returned: always Sample: |
|
Database from which the snapshot was created. Returned: always Sample: |
|
Amazon Resource Name for the snapshot. Returned: always Sample: |
|
Name of the snapshot. Returned: always Sample: |
|
The identifier for the source DB instance, which can’t be changed and which is unique to an AWS Region. Returned: always Sample: |
|
Whether the snapshot is encrypted. Returned: always Sample: |
|
Engine of the database from which the snapshot was created. Returned: always Sample: |
|
Version of the database from which the snapshot was created. Returned: always Sample: |
|
Whether IAM database authentication is enabled. Returned: always Sample: |
|
Creation time of the instance from which the snapshot was created. Returned: always Sample: |
|
License model of the database. Returned: always Sample: |
|
Master username of the database. Returned: always Sample: |
|
Option group of the database. Returned: always Sample: |
|
How much progress has been made taking the snapshot. Will be 100 for an available snapshot. Returned: always Sample: |
|
Port on which the database is listening. Returned: always Sample: |
|
List of processor features of the database. Returned: always Sample: |
|
Creation time of the snapshot. Returned: always Sample: |
|
How the snapshot was created (always manual for this module!). Returned: always Sample: |
|
The DB snapshot ARN that the DB snapshot was copied from. Returned: when snapshot is a copy Sample: |
|
Status of the snapshot. Returned: always Sample: |
|
Storage type of the database. Returned: always Sample: |
|
Tags applied to the snapshot. Returned: always |
|
ID of the VPC in which the DB lives. Returned: always Sample: |