amazon.aws.rds_instance_snapshot module – Manage Amazon RDS instance snapshots
Note
This module is part of the amazon.aws collection (version 5.5.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_instance_snapshot.
New in amazon.aws 5.0.0
Synopsis
Creates or deletes RDS snapshots.
This module was originally added to
community.awsin release 1.0.0.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.18.0
botocore >= 1.21.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. |
|
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 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 |
|
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. |
|
If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tags parameter is not set then tags will not be modified, even if purge_tags=True. Tag keys beginning with Choices:
|
|
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 |
|
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:
|
|
A dictionary representing the tags to be applied to the resource. If the tags parameter is not set then tags will not be modified. |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
|
Whether or not to wait for snapshot creation or deletion. Choices:
|
|
how long before wait gives up, in seconds. Default: |
Notes
Note
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: Create snapshot
amazon.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
amazon.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: true
- name: Delete snapshot
amazon.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: |