View a markdown version of this page

AWS::RDS::ClusterSnapshot - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::RDS::ClusterSnapshot

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::RDS::ClusterSnapshot",
  "Properties" : {
      "DBClusterIdentifier" : String,
      "DBClusterSnapshotIdentifier" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::RDS::ClusterSnapshot
Properties:
  DBClusterIdentifier: String
  DBClusterSnapshotIdentifier: String
  Tags: 
    - Tag

Properties

DBClusterIdentifier

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

Required: Yes

Type: String

Update requires: Replacement

DBClusterSnapshotIdentifier

The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1-snapshot1

Required: Yes

Type: String

Pattern: ^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$

Minimum: 1

Maximum: 63

Update requires: Replacement

Tags

The tags to be assigned to the DB cluster snapshot.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

AllocatedStorage

The allocated storage size of the DB cluster snapshot in gibibytes (GiB).

AvailabilityZones

The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

ClusterCreateTime

The time when the DB cluster was created, in Universal Coordinated Time (UTC).

DbClusterResourceId

The resource ID of the DB cluster that this DB cluster snapshot was created from.

DBClusterSnapshotArn

The Amazon Resource Name (ARN) for the DB cluster snapshot.

Engine

The name of the database engine for this DB cluster snapshot.

EngineMode

The engine mode of the database engine for this DB cluster snapshot.

EngineVersion

The version of the database engine for this DB cluster snapshot.

IAMDatabaseAuthenticationEnabled

Indicates whether mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled.

KmsKeyId

If StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster snapshot.

The Amazon KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

LicenseModel

The license model information for this DB cluster snapshot.

MasterUsername

The master username for this DB cluster snapshot.

Port

The port that the DB cluster was listening on at the time of the snapshot.

SnapshotCreateTime

The time when the snapshot was taken, in Universal Coordinated Time (UTC).

SnapshotType

The type of the DB cluster snapshot.

Status

The status of this DB cluster snapshot. Valid statuses are the following:

  • available

  • copying

  • creating

StorageEncrypted

Indicates whether the DB cluster snapshot is encrypted.

VpcId

The VPC ID associated with the DB cluster snapshot.