Try Spottermanage Amazon RDS snapshots.
| "added in version" 2.9 of ansible.builtin"
Authors: Will Thames (@willthames), Michael De La Rue (@mikedlr)
preview | supported by community
pipInstall with pip install ansible==2.9.13
Creates or deletes RDS snapshots.
# Create snapshot
- rds_snapshot:
db_instance_identifier: new-database
db_snapshot_identifier: new-database-snapshot
# Delete snapshot
- rds_snapshot:
db_snapshot_identifier: new-database-snapshot
state: absent
tags:
description:
- tags dict to apply to a snapshot.
type: dict
wait:
default: 'no'
description:
- Whether or not to wait for snapshot creation or deletion.
type: bool
state:
choices:
- present
- absent
default: present
description:
- Specify the desired state of the snapshot.
type: str
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use.
- For global services such as IAM, Route53 and CloudFront, I(region) is ignored.
- The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used.
- See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region).
- The C(ec2_region) alias has been deprecated and will be removed in a release after
2024-12-01
- Support for the C(EC2_REGION) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
profile:
aliases:
- aws_profile
description:
- A named AWS profile to use for authentication.
- See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
- The C(AWS_PROFILE) environment variable may also be used.
- The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
and I(security_token) options.
type: str
access_key:
aliases:
- aws_access_key_id
- aws_access_key
- ec2_access_key
description:
- AWS access key ID.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables
may also be used in decreasing order of preference.
- The I(aws_access_key) and I(profile) options are mutually exclusive.
- The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the
AWS botocore SDK.
- The I(ec2_access_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
type: dict
purge_tags:
default: true
description:
- whether to remove tags not present in the C(tags) parameter.
type: bool
secret_key:
aliases:
- aws_secret_access_key
- aws_secret_key
- ec2_secret_key
description:
- AWS secret access key.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment
variables may also be used in decreasing order of preference.
- The I(secret_key) and I(profile) options are mutually exclusive.
- The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with
the AWS botocore SDK.
- The I(ec2_secret_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
endpoint_url:
aliases:
- ec2_url
- aws_endpoint_url
- s3_url
description:
- 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 C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing
order of preference.
- The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in
a release after 2024-12-01.
- Support for the C(EC2_URL) environment variable has been deprecated and will be
removed in a release after 2024-12-01.
type: str
wait_timeout:
default: 300
description:
- how long before wait gives up, in seconds.
type: int
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- The C(AWS_CA_BUNDLE) environment variable may also be used.
type: path
session_token:
aliases:
- aws_session_token
- security_token
- aws_security_token
- access_token
description:
- AWS STS session token for use with temporary credentials.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment
variables may also be used in decreasing order of preference.
- The I(security_token) and I(profile) options are mutually exclusive.
- Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with
the parameter being renamed from I(security_token) to I(session_token) in release
6.0.0.
- The I(security_token), I(aws_security_token), and I(access_token) aliases have been
deprecated and will be removed in a release after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables
has been deprecated and will be removed in a release after 2024-12-01.
type: str
validate_certs:
default: true
description:
- When set to C(false), SSL certificates will not be validated for communication with
the AWS APIs.
- Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider
setting I(aws_ca_bundle) instead.
type: bool
db_instance_identifier:
aliases:
- instance_id
description:
- Database instance identifier. Required when state is present.
type: str
db_snapshot_identifier:
aliases:
- id
- snapshot_id
description:
- The snapshot to manage.
required: true
type: str
debug_botocore_endpoint_logs:
default: false
description:
- Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action")
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the C(aws_resource_action) callback to output to total list made
during a playbook.
- The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used.
type: bool
allocated_storage:
description: How much storage is allocated in GB.
returned: always
sample: 20
type: int
availability_zone:
description: Availability zone of the database from which the snapshot was created.
returned: always
sample: us-west-2a
type: str
db_instance_identifier:
description: Database from which the snapshot was created.
returned: always
sample: ansible-test-16638696
type: str
db_snapshot_arn:
description: Amazon Resource Name for the snapshot.
returned: always
sample: arn:aws:rds:us-west-2:123456789012:snapshot:ansible-test-16638696-test-snapshot
type: str
db_snapshot_identifier:
description: Name of the snapshot.
returned: always
sample: ansible-test-16638696-test-snapshot
type: str
dbi_resource_id:
description: The identifier for the source DB instance, which can't be changed and
which is unique to an AWS Region.
returned: always
sample: db-MM4P2U35RQRAMWD3QDOXWPZP4U
type: str
encrypted:
description: Whether the snapshot is encrypted.
returned: always
sample: false
type: bool
engine:
description: Engine of the database from which the snapshot was created.
returned: always
sample: mariadb
type: str
engine_version:
description: Version of the database from which the snapshot was created.
returned: always
sample: 10.2.21
type: str
iam_database_authentication_enabled:
description: Whether IAM database authentication is enabled.
returned: always
sample: false
type: bool
instance_create_time:
description: Creation time of the instance from which the snapshot was created.
returned: always
sample: '2019-06-15T10:15:56.221000+00:00'
type: str
license_model:
description: License model of the database.
returned: always
sample: general-public-license
type: str
master_username:
description: Master username of the database.
returned: always
sample: test
type: str
option_group_name:
description: Option group of the database.
returned: always
sample: default:mariadb-10-2
type: str
percent_progress:
description: How much progress has been made taking the snapshot. Will be 100 for
an available snapshot.
returned: always
sample: 100
type: int
port:
description: Port on which the database is listening.
returned: always
sample: 3306
type: int
processor_features:
description: List of processor features of the database.
returned: always
sample: []
type: list
snapshot_create_time:
description: Creation time of the snapshot.
returned: always
sample: '2019-06-15T10:46:23.776000+00:00'
type: str
snapshot_type:
description: How the snapshot was created (always manual for this module!).
returned: always
sample: manual
type: str
status:
description: Status of the snapshot.
returned: always
sample: available
type: str
storage_type:
description: Storage type of the database.
returned: always
sample: gp2
type: str
tags:
contains: {}
description: Tags applied to the snapshot.
returned: always
type: complex
vpc_id:
description: ID of the VPC in which the DB lives.
returned: always
sample: vpc-09ff232e222710ae0
type: str