db_cluster_snapshots

Creates, updates, deletes, gets or lists a db_cluster_snapshots resource.

Overview

Name	db_cluster_snapshots
Type	Resource
Id	aws.rds.db_cluster_snapshots

Fields

The following fields are returned by SELECT queries:

describe_db_cluster_snapshots

Name	Datatype	Description
allocated_storage	integer	The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
availability_zones	string	The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
backup_retention_period	integer	The number of days for which automatic DB snapshots are retained.
cluster_create_time	string	The time when the DB cluster was created, in Universal Coordinated Time (UTC).
db_cluster_identifier	string	The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
db_cluster_snapshot_arn	string	The Amazon Resource Name (ARN) for the DB cluster snapshot.
db_cluster_snapshot_identifier	string	The identifier for the DB cluster snapshot.
db_system_id	string	Reserved for future use.
db_cluster_resource_id	string	The resource ID of the DB cluster that this DB cluster snapshot was created from.
engine	string	The name of the database engine for this DB cluster snapshot.
engine_mode	string	The engine mode of the database engine for this DB cluster snapshot.
engine_version	string	The version of the database engine for this DB cluster snapshot.
iam_database_authentication_enabled	boolean	Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
kms_key_id	string	If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
license_model	string	The license model information for this DB cluster snapshot.
master_username	string	The master username for this DB cluster snapshot.
percent_progress	integer	The percentage of the estimated data that has been transferred.
port	integer	The port that the DB cluster was listening on at the time of the snapshot.
preferred_backup_window	string	The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
snapshot_create_time	string	The time when the snapshot was taken, in Universal Coordinated Time (UTC).
snapshot_type	string	The type of the DB cluster snapshot.
source_db_cluster_snapshot_arn	string	If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
status	string	The status of this DB cluster snapshot. Valid statuses are the following: available copying creating
storage_encrypted	boolean	Indicates whether the DB cluster snapshot is encrypted.
storage_encryption_type	string	The type of encryption used to protect data at rest in the DB cluster snapshot. Possible values: none - The DB cluster snapshot is not encrypted. sse-rds - The DB cluster snapshot is encrypted using an Amazon Web Services owned KMS key. sse-kms - The DB cluster snapshot is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.
storage_throughput	integer	The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable. This setting is only for non-Aurora Multi-AZ DB clusters.
storage_type	string	The storage type associated with the DB cluster snapshot. This setting is only for Aurora DB clusters.
tag_list	string	A list of tags. For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
vpc_id	string	The VPC ID associated with the DB cluster snapshot.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_db_cluster_snapshots	select	region	DBClusterIdentifier, DBClusterSnapshotIdentifier, SnapshotType, Filters, MaxRecords, Marker, IncludeShared, IncludePublic, DbClusterResourceId	Returns information about DB cluster snapshots. This API action supports pagination. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
create_db_cluster_snapshot	insert	DBClusterSnapshotIdentifier, DBClusterIdentifier, region	Tags	Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
delete_db_cluster_snapshot	delete	DBClusterSnapshotIdentifier, region		Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the available state to be deleted. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
DBClusterIdentifier	string	The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive. Constraints: Must match the identifier of an existing DBCluster. Example: my-cluster1
DBClusterSnapshotIdentifier	string	The identifier of the DB cluster snapshot to delete. Constraints: Must be the name of an existing DB cluster snapshot in the available state.
region	string	AWS region (default: us-east-1)
DBClusterIdentifier	string	The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive. Constraints: If supplied, must match the identifier of an existing DBCluster.
DBClusterSnapshotIdentifier	string	A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string. Constraints: If supplied, must match the identifier of an existing DBClusterSnapshot. If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
DbClusterResourceId	string	A specific DB cluster resource ID to describe.
Filters	array	A filter that specifies one or more DB cluster snapshots to describe. Supported filters: db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers. snapshot-type - Accepts types of DB cluster snapshots. engine - Accepts names of database engines.
IncludePublic	boolean	Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included. You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
IncludeShared	boolean	Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included. You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.
Marker	string	An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
MaxRecords	integer	The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
SnapshotType	string	The type of DB cluster snapshots to be returned. You can specify one of the following values: automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account. manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account. shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account. public - Return all DB cluster snapshots that have been marked as public. If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter. The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.
Tags	array	The tags to be assigned to the DB cluster snapshot.

SELECT examples

describe_db_cluster_snapshots

Returns information about DB cluster snapshots. This API action supports pagination. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

SELECT
allocated_storage,
availability_zones,
backup_retention_period,
cluster_create_time,
db_cluster_identifier,
db_cluster_snapshot_arn,
db_cluster_snapshot_identifier,
db_system_id,
db_cluster_resource_id,
engine,
engine_mode,
engine_version,
iam_database_authentication_enabled,
kms_key_id,
license_model,
master_username,
percent_progress,
port,
preferred_backup_window,
snapshot_create_time,
snapshot_type,
source_db_cluster_snapshot_arn,
status,
storage_encrypted,
storage_encryption_type,
storage_throughput,
storage_type,
tag_list,
vpc_id
FROM aws.rds.db_cluster_snapshots
WHERE region = '{{ region }}' -- required
AND DBClusterIdentifier = '{{ DBClusterIdentifier }}'
AND DBClusterSnapshotIdentifier = '{{ DBClusterSnapshotIdentifier }}'
AND SnapshotType = '{{ SnapshotType }}'
AND Filters = '{{ Filters }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
AND IncludeShared = '{{ IncludeShared }}'
AND IncludePublic = '{{ IncludePublic }}'
AND DbClusterResourceId = '{{ DbClusterResourceId }}'
;

INSERT examples

create_db_cluster_snapshot

Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

INSERT INTO aws.rds.db_cluster_snapshots (
DBClusterSnapshotIdentifier,
DBClusterIdentifier,
region,
Tags
)
SELECT 
'{{ DBClusterSnapshotIdentifier }}',
'{{ DBClusterIdentifier }}',
'{{ region }}',
'{{ Tags }}'
RETURNING
allocated_storage,
availability_zones,
backup_retention_period,
cluster_create_time,
db_cluster_identifier,
db_cluster_snapshot_arn,
db_cluster_snapshot_identifier,
db_system_id,
db_cluster_resource_id,
engine,
engine_mode,
engine_version,
iam_database_authentication_enabled,
kms_key_id,
license_model,
master_username,
percent_progress,
port,
preferred_backup_window,
snapshot_create_time,
snapshot_type,
source_db_cluster_snapshot_arn,
status,
storage_encrypted,
storage_encryption_type,
storage_throughput,
storage_type,
tag_list,
vpc_id
;

Manifest

# Description fields are for documentation purposes
- name: db_cluster_snapshots
props:
  - name: DBClusterSnapshotIdentifier
    value: "{{ DBClusterSnapshotIdentifier }}"
    description: Required parameter for the db_cluster_snapshots resource.
  - name: DBClusterIdentifier
    value: "{{ DBClusterIdentifier }}"
    description: Required parameter for the db_cluster_snapshots resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the db_cluster_snapshots resource.
  - name: Tags
    value: "{{ Tags }}"
    description: The tags to be assigned to the DB cluster snapshot.
    description: The tags to be assigned to the DB cluster snapshot.

DELETE examples

delete_db_cluster_snapshot

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. The DB cluster snapshot must be in the available state to be deleted. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

DELETE FROM aws.rds.db_cluster_snapshots
WHERE DBClusterSnapshotIdentifier = '{{ DBClusterSnapshotIdentifier }}' --required
AND region = '{{ region }}' --required
;