View a markdown version of this page

AWS::DocDBElastic::ClusterSnapshot - AWS CloudFormation
SyntaxPropertiesReturn values

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

AWS::DocDBElastic::ClusterSnapshot

Returns information about a specific elastic cluster snapshot.

Syntax

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

JSON

{
  "Type" : "AWS::DocDBElastic::ClusterSnapshot",
  "Properties" : {
      "ClusterArn" : String,
      "SnapshotName" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::DocDBElastic::ClusterSnapshot
Properties:
  ClusterArn: String
  SnapshotName: String
  Tags: 
    - Tag

Properties

ClusterArn

The ARN identifier of the elastic cluster.

Required: Yes

Type: String

Update requires: Replacement

SnapshotName

The name of the elastic cluster snapshot.

Required: Yes

Type: String

Minimum: 1

Maximum: 63

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

AdminUserName

The name of the elastic cluster administrator.

ClusterCreationTime

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

KmsKeyId

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

SnapshotArn

The ARN identifier of the elastic cluster snapshot.

SnapshotCreationTime

The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).

SnapshotType

The type of cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your AWS account.

  • manual - Return all cluster snapshots that you have manually created for your AWS account.

Status

The status of the elastic cluster snapshot.

SubnetIds

The Amazon EC2 subnet IDs for the elastic cluster.

VpcSecurityGroupIds

A list of EC2 VPC security groups to associate with the elastic cluster.