Try Spotterobtain information about one or more RDS snapshots
| "added in version" 1.0.0 of community.aws"
Authors: Will Thames (@willthames)
Install with ansible-galaxy collection install community.aws:==1.1.0
collections:
- name: community.aws
version: 1.1.0Obtain information about one or more RDS snapshots. These can be for unclustered snapshots or snapshots of clustered DBs (Aurora).
Aurora snapshot information may be obtained if no identifier parameters are passed or if one of the cluster parameters are passed.
This module was called C(rds_snapshot_facts) before Ansible 2.9. The usage did not change.
- name: Get information about an snapshot
community.aws.rds_snapshot_info:
db_snapshot_identifier: snapshot_name
register: new_database_info
- name: Get all RDS snapshots for an RDS instance
community.aws.rds_snapshot_info:
db_instance_identifier: helloworld-rds-master
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
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
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
snapshot_type:
choices:
- automated
- manual
- shared
- public
description:
- Type of snapshot to find.
- By default both automated and manual snapshots will be returned.
required: false
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_cluster_identifier:
description:
- RDS cluster name for which to find snapshots.
- Mutually exclusive with I(db_snapshot_identifier), I(db_instance_identifier), I(db_cluster_snapshot_identifier)
required: false
type: str
db_instance_identifier:
description:
- RDS instance name for which to find snapshots.
- Mutually exclusive with I(db_snapshot_identifier), I(db_cluster_identifier), I(db_cluster_snapshot_identifier)
required: false
type: str
db_snapshot_identifier:
aliases:
- snapshot_name
description:
- Name of an RDS (unclustered) snapshot.
- Mutually exclusive with I(db_instance_identifier), I(db_cluster_identifier), I(db_cluster_snapshot_identifier)
required: false
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
db_cluster_snapshot_identifier:
description:
- Name of an RDS cluster snapshot.
- Mutually exclusive with I(db_instance_identifier), I(db_snapshot_identifier), I(db_cluster_identifier)
required: false
type: str
cluster_snapshots:
contains:
allocated_storage:
description: How many gigabytes of storage are allocated
returned: always
sample: 1
type: int
availability_zones:
description: The availability zones of the database from which the snapshot
was taken
returned: always
sample:
- ca-central-1a
- ca-central-1b
type: list
cluster_create_time:
description: Date and time the cluster was created
returned: always
sample: '2018-05-17T00:13:40.223000+00:00'
type: str
db_cluster_identifier:
description: Database cluster identifier
returned: always
sample: test-aurora-cluster
type: str
db_cluster_snapshot_arn:
description: ARN of the database snapshot
returned: always
sample: arn:aws:rds:ca-central-1:111111111111:cluster-snapshot:test-aurora-snapshot
type: str
db_cluster_snapshot_identifier:
description: Snapshot identifier
returned: always
sample: test-aurora-snapshot
type: str
engine:
description: Database engine
returned: always
sample: aurora
type: str
engine_version:
description: Database engine version
returned: always
sample: 5.6.10a
type: str
iam_database_authentication_enabled:
description: Whether database authentication through IAM is enabled
returned: always
sample: false
type: bool
kms_key_id:
description: ID of the KMS Key encrypting the snapshot
returned: always
sample: arn:aws:kms:ca-central-1:111111111111:key/abcd1234-abcd-1111-aaaa-0123456789ab
type: str
license_model:
description: License model
returned: always
sample: aurora
type: str
master_username:
description: Database master username
returned: always
sample: shertel
type: str
percent_progress:
description: Percent progress of snapshot
returned: always
sample: 0
type: int
port:
description: Database port
returned: always
sample: 0
type: int
snapshot_create_time:
description: Date and time when the snapshot was created
returned: always
sample: '2018-05-17T00:23:23.731000+00:00'
type: str
snapshot_type:
description: Type of snapshot
returned: always
sample: manual
type: str
status:
description: Status of snapshot
returned: always
sample: creating
type: str
storage_encrypted:
description: Whether the snapshot is encrypted
returned: always
sample: true
type: bool
tags:
contains: {}
description: Tags of the snapshot
returned: when snapshot is not shared
type: complex
vpc_id:
description: VPC of the database
returned: always
sample: vpc-abcd1234
type: str
description: List of cluster snapshots
returned: always
type: complex
snapshots:
contains:
allocated_storage:
description: How many gigabytes of storage are allocated
returned: always
sample: 10
type: int
availability_zone:
description: The availability zone of the database from which the snapshot was
taken
returned: always
sample: us-west-2b
type: str
db_instance_identifier:
description: Database instance identifier
returned: always
sample: hello-world-rds
type: str
db_snapshot_arn:
description: Snapshot ARN
returned: always
sample: arn:aws:rds:us-west-2:111111111111:snapshot:rds:hello-world-rds-us1-2018-05-16-04-03
type: str
db_snapshot_identifier:
description: Snapshot name
returned: always
sample: rds:hello-world-rds-us1-2018-05-16-04-03
type: str
encrypted:
description: Whether the snapshot was encrypted
returned: always
sample: true
type: bool
engine:
description: Database engine
returned: always
sample: postgres
type: str
engine_version:
description: Database engine version
returned: always
sample: 9.5.10
type: str
iam_database_authentication_enabled:
description: Whether database authentication through IAM is enabled
returned: always
sample: false
type: bool
instance_create_time:
description: Time the Instance was created
returned: always
sample: '2017-10-10T04:00:07.434000+00:00'
type: str
kms_key_id:
description: ID of the KMS Key encrypting the snapshot
returned: always
sample: arn:aws:kms:us-west-2:111111111111:key/abcd1234-1234-aaaa-0000-1234567890ab
type: str
license_model:
description: License model
returned: always
sample: postgresql-license
type: str
master_username:
description: Database master username
returned: always
sample: dbadmin
type: str
option_group_name:
description: Database option group name
returned: always
sample: default:postgres-9-5
type: str
percent_progress:
description: Percent progress of snapshot
returned: always
sample: 100
type: int
snapshot_create_time:
description: Time snapshot was created
returned: always
sample: '2018-05-16T04:03:33.871000+00:00'
type: str
snapshot_type:
description: Type of snapshot
returned: always
sample: automated
type: str
status:
description: Status of snapshot
returned: always
sample: available
type: str
storage_type:
description: Storage type of underlying DB
returned: always
sample: gp2
type: str
tags:
contains: {}
description: Snapshot tags
returned: when snapshot is not shared
type: complex
vpc_id:
description: ID of VPC containing the DB
returned: always
sample: vpc-abcd1234
type: str
description: List of non-clustered snapshots
returned: When cluster parameters are not passed
type: complex