Try SpotterManage Amazon RDS snapshots of DB clusters
| "added in version" 4.0.0 of community.aws"
Authors: Alina Buzachis (@alinabuzachis)
Install with ansible-galaxy collection install community.aws:==2.6.0
collections:
- name: community.aws
version: 2.6.0Create, modify and delete RDS snapshots of DB clusters.
- name: Create a DB cluster snapshot
community.aws.rds_cluster_snapshot:
db_cluster_identifier: "{{ cluster_id }}"
db_cluster_snapshot_identifier: new-cluster-snapshot
- name: Delete a DB cluster snapshot
community.aws.rds_cluster_snapshot:
db_cluster_snapshot_identifier: new-cluster-snapshot
state: absent
- name: Copy snapshot from a different region and copy its tags
community.aws.rds_cluster_snapshot:
id: new-database-snapshot-copy
region: us-east-1
source_id: "{{ snapshot.db_snapshot_arn }}"
source_region: us-east-2
copy_tags: yes
tags:
aliases:
- resource_tags
description:
- A dictionary representing the tags to be applied to the resource.
- If the I(tags) parameter is not set then tags will not be modified.
required: false
type: dict
wait:
default: false
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. If not specified then the value of the AWS_REGION or EC2_REGION
environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
profile:
aliases:
- aws_profile
description:
- The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
and I(security_token) options.
type: str
copy_tags:
default: false
description:
- Whether to copy all tags from I(source_db_cluster_snapshot_identifier) to I(db_cluster_snapshot_identifier).
type: bool
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
type: dict
purge_tags:
default: true
description:
- If I(purge_tags=true) and I(tags) is set, existing tags will be purged from the
resource to match exactly what is defined by I(tags) parameter.
- If the I(tags) parameter is not set then tags will not be modified, even if I(purge_tags=True).
- Tag keys beginning with C(aws:) are reserved by Amazon and can not be modified. As
such they will be ignored for the purposes of the I(purge_tags) parameter. See
the Amazon documentation for more information U(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions).
required: false
type: bool
endpoint_url:
aliases:
- ec2_url
- aws_endpoint_url
- s3_url
description:
- 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.
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.
- 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
from the controller if not run locally.'
type: path
source_region:
description:
- The region that contains the snapshot to be copied.
type: str
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
or C(EC2_ACCESS_KEY) environment variable is used.
- The I(aws_access_key) and I(profile) options are mutually exclusive.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
or C(EC2_SECRET_KEY) environment variable is used.
- The I(aws_secret_key) and I(profile) options are mutually exclusive.
type: str
security_token:
aliases:
- aws_session_token
- session_token
- aws_security_token
- access_token
description:
- C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
or C(EC2_SECURITY_TOKEN) environment variable is used.
- The I(security_token) and I(profile) options are mutually exclusive.
- Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for communication with
the AWS APIs.
type: bool
db_cluster_identifier:
aliases:
- cluster_id
- cluster_name
description:
- The identifier of the DB cluster to create a snapshot for.
- Required when I(state=present).
type: str
debug_botocore_endpoint_logs:
default: 'no'
description:
- 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.
type: bool
db_cluster_snapshot_identifier:
aliases:
- snapshot_id
- id
- snapshot_name
description:
- The identifier of the DB cluster snapshot.
required: true
type: str
source_db_cluster_snapshot_identifier:
aliases:
- source_id
- source_snapshot_id
description:
- The identifier of the DB cluster snapshot to copy.
- 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.
type: str
allocated_storage:
description: Specifies the allocated storage size in gibibytes (GiB).
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
cluster_create_time:
description: Specifies the time when the DB cluster was created, in Universal Coordinated
Time (UTC).
returned: always
sample: '2019-06-15T10:15:56.221000+00:00'
type: str
db_cluster_identifier:
description: Specifies the DB cluster identifier of the DB cluster that this DB
cluster snapshot was created from.
returned: always
sample: ansible-test-16638696
type: str
db_cluster_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_cluster_snapshot_identifier:
description: Specifies the identifier for the DB cluster snapshot.
returned: always
sample: ansible-test-16638696-test-snapshot
type: str
engine:
description: Specifies the name of the database engine for this DB cluster snapshot.
returned: always
sample: aurora
type: str
engine_mode:
description: Provides the engine mode of the database engine for this DB cluster
snapshot.
returned: always
sample: 5.6.mysql_aurora.1.22.5
type: str
engine_version:
description: Version of the cluster from which the snapshot was created.
returned: always
sample: 5.6.mysql_aurora.1.22.5
type: str
iam_database_authentication_enabled:
description: Whether IAM database authentication is enabled.
returned: always
sample: false
type: bool
kms_key_id:
description: The Amazon Web Services KMS key identifier is the key ARN, key ID,
alias ARN, or alias name for the KMS key.
returned: always
type: str
license_model:
description: Provides the license model information for this DB cluster snapshot.
returned: always
sample: general-public-license
type: str
master_username:
description: Provides the master username for this DB cluster snapshot.
returned: always
sample: test
type: str
percent_progress:
description: Specifies the percentage of the estimated data that has been transferred.
returned: always
sample: 100
type: int
port:
description: Port on which the database is listening.
returned: always
sample: 3306
type: int
snapshot_create_time:
description: Provides the time when the snapshot was taken, in Universal Coordinated
Time (UTC).
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
source_db_cluster_snapshot_arn:
description: If the DB cluster snapshot was copied from a source DB cluster snapshot,
the ARN for the source DB cluster snapshot, otherwise, null.
returned: always
sample: null
type: str
status:
description: Specifies the status of this DB cluster snapshot.
returned: always
sample: available
type: str
storage_encrypted:
description: Specifies whether the DB cluster snapshot is encrypted.
returned: always
sample: false
type: bool
tag_list:
description: A list of tags.
returned: always
sample: []
type: list
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