db_cluster_snapshots

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

Overview

Name	db_cluster_snapshots
Type	Resource
Id	aws.neptune.db_cluster_snapshots

Fields

The following fields are returned by SELECT queries:

describe_db_cluster_snapshots

Name	Datatype	Description
allocated_storage	integer	Specifies the allocated storage size in gibibytes (GiB).
availability_zones	string	Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
cluster_create_time	string	Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
db_cluster_identifier	string	Specifies 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	Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot. After you restore a DB cluster using a DBClusterSnapshotIdentifier, you must specify the same DBClusterSnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the DBClusterSnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the DBClusterSnapshotIdentifier, and the original DB cluster is deleted.
engine	string	Specifies the name of the database engine.
engine_version	string	Provides the version of the database engine for this DB cluster snapshot.
iam_database_authentication_enabled	boolean	True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
kms_key_id	string	If StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster snapshot.
license_model	string	Provides the license model information for this DB cluster snapshot.
master_username	string	Not supported by Neptune.
percent_progress	integer	Specifies the percentage of the estimated data that has been transferred.
port	integer	Specifies the port that the DB cluster was listening on at the time of the snapshot.
snapshot_create_time	string	Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
snapshot_type	string	Provides 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	Specifies the status of this DB cluster snapshot.
storage_encrypted	boolean	Specifies whether the DB cluster snapshot is encrypted.
storage_type	string	The storage type associated with the DB cluster snapshot.
vpc_id	string	Provides 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	Returns information about DB cluster snapshots. This API action supports pagination.
create_db_cluster_snapshot	insert	DBClusterSnapshotIdentifier, DBClusterIdentifier, region	Tags	Creates a snapshot of a DB cluster.
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.

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 is not 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 is not 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.
Filters	array	This parameter is not currently supported.
IncludePublic	boolean	True to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon account, and otherwise false. The default is false. The default is false. You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
IncludeShared	boolean	True to include shared manual DB cluster snapshots from other Amazon accounts that this Amazon account has been given permission to copy or restore, and otherwise false. The default is false. You can give an Amazon account permission to restore a manual DB cluster snapshot from another Amazon 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 that the remaining results can be retrieved. 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 Neptune for my Amazon account. manual - Return all DB cluster snapshots that have been taken by my Amazon account. shared - Return all manual DB cluster snapshots that have been shared to my Amazon 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 setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic parameter to true. 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.

SELECT
allocated_storage,
availability_zones,
cluster_create_time,
db_cluster_identifier,
db_cluster_snapshot_arn,
db_cluster_snapshot_identifier,
engine,
engine_version,
iam_database_authentication_enabled,
kms_key_id,
license_model,
master_username,
percent_progress,
port,
snapshot_create_time,
snapshot_type,
source_db_cluster_snapshot_arn,
status,
storage_encrypted,
storage_type,
vpc_id
FROM aws.neptune.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 }}'
;

INSERT examples

create_db_cluster_snapshot

Creates a snapshot of a DB cluster.

INSERT INTO aws.neptune.db_cluster_snapshots (
DBClusterSnapshotIdentifier,
DBClusterIdentifier,
region,
Tags
)
SELECT 
'{{ DBClusterSnapshotIdentifier }}',
'{{ DBClusterIdentifier }}',
'{{ region }}',
'{{ Tags }}'
RETURNING
allocated_storage,
availability_zones,
cluster_create_time,
db_cluster_identifier,
db_cluster_snapshot_arn,
db_cluster_snapshot_identifier,
engine,
engine_version,
iam_database_authentication_enabled,
kms_key_id,
license_model,
master_username,
percent_progress,
port,
snapshot_create_time,
snapshot_type,
source_db_cluster_snapshot_arn,
status,
storage_encrypted,
storage_type,
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.

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