AWS::DocDB::GlobalCluster

DocDB GlobalCluster

The AWS::DocDB::GlobalCluster resource represents an Amazon DocumentDB Global Cluster.

Properties

7 configurable properties. 1 required. Click a row to see details.

Filter:

Property	Type	Flags
`GlobalClusterIdentifier`	`string`	RequiredCreate-only
`DeletionProtection`	`boolean`
`Engine`	`string`	Create-only
`EngineVersion`	`string`	Create-only
`SourceDBClusterIdentifier`	`Any \| Any`	Create-onlyWrite-only
`StorageEncrypted`	`boolean`	Create-only
`Tags`	`Array<Tag>`

Return Values

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

Attribute	Type	Description
`GlobalClusterArn`	`string`	The Amazon Resource Name (ARN) for the global cluster.
`GlobalClusterResourceId`	`string`	The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::DocDB::GlobalCluster

Resources:
  MyResource:
    Type: AWS::DocDB::GlobalCluster
    Properties:
      GlobalClusterIdentifier: "my-globalclusteridentifier"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

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

create

rds:CreateGlobalClusterrds:DescribeGlobalClustersrds:DescribeDBClustersrds:AddTagsToResourcerds:ListTagsForResource

read

rds:DescribeGlobalClustersrds:ListTagsForResource

update

rds:ModifyGlobalClusterrds:DescribeGlobalClustersrds:AddTagsToResourcerds:ListTagsForResourcerds:RemoveTagsFromResource

delete

rds:DeleteGlobalClusterrds:DescribeGlobalClustersrds:RemoveFromGlobalClusterrds:DescribeDBClusters

list

rds:DescribeGlobalClustersrds:ListTagsForResource

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceDocDB

Properties9

Required1

TaggingSupported

Primary IDGlobalClusterIdentifier

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

EngineEngineVersionGlobalClusterIdentifierSourceDBClusterIdentifierStorageEncrypted

Related Resources

External Links

AWS Documentation