AWS::RDS::ClusterSnapshot

RDS ClusterSnapshot

Creates a snapshot of a DB cluster.

Properties

3 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`DBClusterIdentifier`	`string`	RequiredCreate-only
`DBClusterSnapshotIdentifier`	`string`	RequiredCreate-only
`Tags`	`Array<Tag>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`AllocatedStorage`	`integer`	The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
`AvailabilityZones`	`Array<string>`	The list of Availability Zones where instances in the DB cluster snapshot can be restored.
`ClusterCreateTime`	`string`	The time when the DB cluster was created, in Universal Coordinated Time (UTC).
`DbClusterResourceId`	`string`	The resource ID of the DB cluster that this DB cluster snapshot was created from.
`DBClusterSnapshotArn`	`string`	The Amazon Resource Name (ARN) for the DB cluster snapshot.
`Engine`	`string`	The name of the database engine for this DB cluster snapshot.
`EngineMode`	`string`	The engine mode of the database engine for this DB cluster snapshot.
`EngineVersion`	`string`	The version of the database engine for this DB cluster snapshot.
`IAMDatabaseAuthenticationEnabled`	`boolean`	Indicates whether mapping of AWS IAM accounts to database accounts is enabled.
`KmsKeyId`	`string`	If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
`LicenseModel`	`string`	The license model information for this DB cluster snapshot.
`MasterUsername`	`string`	The master username for this DB cluster snapshot.
`Port`	`integer`	The port that the DB cluster was listening on at the time of the snapshot.
`SnapshotCreateTime`	`string`	The time when the snapshot was taken, in Universal Coordinated Time (UTC).
`SnapshotType`	`string`	The type of the DB cluster snapshot.
`Status`	`string`	The status of this DB cluster snapshot.
`StorageEncrypted`	`boolean`	Indicates whether the DB cluster snapshot is encrypted.
`VpcId`	`string`	The VPC ID associated with the DB cluster snapshot.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::RDS::ClusterSnapshot

Resources:
  MyResource:
    Type: AWS::RDS::ClusterSnapshot
    Properties:
      DBClusterSnapshotIdentifier: "my-dbclustersnapshotidentifier"
      DBClusterIdentifier: "my-dbclusteridentifier"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

rds:CreateDBClusterSnapshotrds:DescribeDBClusterSnapshotsrds:DescribeDBClustersrds:AddTagsToResourcerds:ListTagsForResource

read

rds:DescribeDBClusterSnapshotsrds:ListTagsForResource

update

rds:DescribeDBClusterSnapshotsrds:ListTagsForResourcerds:AddTagsToResourcerds:RemoveTagsFromResource

delete

rds:DeleteDBClusterSnapshotrds:DescribeDBClusterSnapshotsrds:ListTagsForResource

list

rds:DescribeDBClusterSnapshots

Get the RDS Cheat Sheet

Everything you need to know about RDS on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceRDS

Properties21

Required2

TaggingSupported

Primary IDDBClusterSnapshotArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

DBClusterSnapshotIdentifierDBClusterIdentifier

Related Resources

External Links

AWS Documentation