AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::DocDB::GlobalCluster

CfnGlobalCluster

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

Import

import { CfnGlobalCluster } from 'aws-cdk-lib/aws-docdb';

Or use the module namespace:

import * as docdb from 'aws-cdk-lib/aws-docdb';
// docdb.CfnGlobalCluster

Properties

Configuration passed to the constructor as CfnGlobalClusterProps.

globalClusterIdentifierRequired
string

The cluster identifier of the global cluster.

deletionProtectionOptional
boolean | IResolvable

Indicates whether the global cluster has deletion protection enabled. The global cluster can't be deleted when deletion protection is enabled.

engineOptional
string

The database engine to use for this global cluster.

Default: - "docdb"

engineVersionOptional
string

The engine version to use for this global cluster.

sourceDbClusterIdentifierOptional
string

The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. You may also choose to instead specify the DBClusterIdentifier. If you provide a value for this parameter, don't specify values for the following settings because Amazon DocumentDB uses the values from the specified source DB cluster: Engine, EngineVersion, StorageEncrypted

storageEncryptedOptional
boolean | IResolvable

Indicates whether the global cluster has storage encryption enabled.

tagsOptional
CfnTag[]

The tags to be assigned to the Amazon DocumentDB resource.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::DocDB::GlobalClusterView in CloudFormation Explorer

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

LevelL1 (CloudFormation)
Moduleaws-docdb
CFN TypeAWS::DocDB::GlobalCluster
Properties7

Related Constructs

Explore This Service

External Links