community.aws.rds_snapshot – manage Amazon RDS snapshots.¶

Note

This plugin is part of the community.aws collection (version 1.4.0).

To install it use: ansible-galaxy collection install community.aws.

To use it in a playbook, specify: community.aws.rds_snapshot.

New in version 1.0.0: of community.aws

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

Creates or deletes RDS snapshots.

Requirements ¶

The below requirements are needed on the host that executes this module.

boto
boto3
python >= 2.6

Parameters ¶

Parameter	Choices/Defaults	Comments
aws_access_key string		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 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. aliases: ec2_access_key, access_key
aws_ca_bundle path		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.
aws_config dictionary		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.
aws_secret_key string		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 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. aliases: ec2_secret_key, secret_key
db_instance_identifier string		Database instance identifier. Required when state is present. aliases: instance_id
db_snapshot_identifier string / required		The snapshot to manage. aliases: id, snapshot_id
debug_botocore_endpoint_logs boolean	Choices: no ← yes	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.
ec2_url string		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. aliases: aws_endpoint_url, endpoint_url
profile string		Uses a boto profile. Only works with boto >= 2.24.0. 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. aliases: aws_profile
purge_tags boolean	Choices: no yes ←	whether to remove tags not present in the `tags` parameter.
region string		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 aliases: aws_region, ec2_region
security_token string		AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. 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_security_token, access_token
state string	Choices: present ← absent	Specify the desired state of the snapshot.
tags dictionary		tags dict to apply to a snapshot.
validate_certs boolean	Choices: no yes ←	When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
wait boolean	Choices: no ← yes	Whether or not to wait for snapshot creation or deletion.
wait_timeout integer	Default: 300	how long before wait gives up, in seconds.

Notes ¶

Note

If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE
Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples ¶

- name: Create snapshot
  community.aws.rds_snapshot:
    db_instance_identifier: new-database
    db_snapshot_identifier: new-database-snapshot

- name: Delete snapshot
  community.aws.rds_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	Returned	Description
allocated_storage integer	always	How much storage is allocated in GB. Sample: 20
availability_zone string	always	Availability zone of the database from which the snapshot was created. Sample: us-west-2a
db_instance_identifier string	always	Database from which the snapshot was created. Sample: ansible-test-16638696
db_snapshot_arn string	always	Amazon Resource Name for the snapshot. Sample: arn:aws:rds:us-west-2:123456789012:snapshot:ansible-test-16638696-test-snapshot
db_snapshot_identifier string	always	Name of the snapshot. Sample: ansible-test-16638696-test-snapshot
dbi_resource_id string	always	The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region. Sample: db-MM4P2U35RQRAMWD3QDOXWPZP4U
encrypted boolean	always	Whether the snapshot is encrypted.
engine string	always	Engine of the database from which the snapshot was created. Sample: mariadb
engine_version string	always	Version of the database from which the snapshot was created. Sample: 10.2.21
iam_database_authentication_enabled boolean	always	Whether IAM database authentication is enabled.
instance_create_time string	always	Creation time of the instance from which the snapshot was created. Sample: 2019-06-15T10:15:56.221000+00:00
license_model string	always	License model of the database. Sample: general-public-license
master_username string	always	Master username of the database. Sample: test
option_group_name string	always	Option group of the database. Sample: default:mariadb-10-2
percent_progress integer	always	How much progress has been made taking the snapshot. Will be 100 for an available snapshot. Sample: 100
port integer	always	Port on which the database is listening. Sample: 3306
processor_features list / elements=string	always	List of processor features of the database.
snapshot_create_time string	always	Creation time of the snapshot. Sample: 2019-06-15T10:46:23.776000+00:00
snapshot_type string	always	How the snapshot was created (always manual for this module!). Sample: manual
status string	always	Status of the snapshot. Sample: available
storage_type string	always	Storage type of the database. Sample: gp2
tags complex	always	Tags applied to the snapshot.
vpc_id string	always	ID of the VPC in which the DB lives. Sample: vpc-09ff232e222710ae0

Authors¶

Will Thames (@willthames)
Michael De La Rue (@mikedlr)

community.aws.rds_snapshot – manage Amazon RDS snapshots.¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶