AWS::DocDB::GlobalCluster

A data type representing an Amazon DocumentDB global cluster.

Syntax

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

JSON

{
  "Type" : "AWS::DocDB::GlobalCluster",
  "Properties" : {
      "DeletionProtection" : Boolean,
      "Engine" : String,
      "EngineVersion" : String,
      "GlobalClusterIdentifier" : String,
      "SourceDBClusterIdentifier" : String,
      "StorageEncrypted" : Boolean,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::DocDB::GlobalCluster
Properties:
  DeletionProtection: Boolean
  Engine: String
  EngineVersion: String
  GlobalClusterIdentifier: String
  SourceDBClusterIdentifier: String
  StorageEncrypted: Boolean
  Tags: 
    - Tag

Properties

DeletionProtection

The deletion protection setting for the new global cluster.

Required: No

Type: Boolean

Update requires: No interruption

Engine

The Amazon DocumentDB database engine used by the global cluster.

Required: No

Type: String

Allowed values: docdb

Update requires: Replacement

EngineVersion

Indicates the database engine version.

Required: No

Type: String

Update requires: Replacement

GlobalClusterIdentifier

Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.

Required: Yes

Type: String

Pattern: ^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$

Minimum: 1

Maximum: 63

Update requires: Replacement

SourceDBClusterIdentifier

The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. This parameter is optional.

Required: No

Type: String

Pattern: ^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$

Update requires: Replacement

StorageEncrypted

The storage encryption setting for the global cluster.

Required: No

Type: Boolean

Update requires: Replacement

Tags

The tags to be assigned to the Amazon DocumentDB resource.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

Fn::GetAtt

GlobalClusterArn

The Amazon Resource Name (ARN) for the global cluster.

GlobalClusterResourceId

The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.