CfnGlobalClusterProps Struct
Properties for defining a CfnGlobalCluster.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_docdb as docdb } from 'aws-cdk-lib';
const cfnGlobalClusterProps: docdb.CfnGlobalClusterProps = {
globalClusterIdentifier: 'globalClusterIdentifier',
// the properties below are optional
deletionProtection: false,
engine: 'engine',
engineVersion: 'engineVersion',
sourceDbClusterIdentifier: 'sourceDbClusterIdentifier',
storageEncrypted: false,
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
deletionProtectionboolean | IResolvabledeletion_protectiontyping.Union[bool, IResolvable]deletionProtectionBooleanDeletionProtectionboolDeletionProtectioninterface{}#Indicates whether the global cluster has deletion protection enabled.
The global cluster can't be deleted when deletion protection is enabled.
The database engine to use for this global cluster.
The engine version to use for this global cluster.
globalClusterIdentifierstringglobal_cluster_identifierstrglobalClusterIdentifierStringGlobalClusterIdentifierstringGlobalClusterIdentifier*stringrequired#The cluster identifier of the global cluster.
sourceDbClusterIdentifierstringsource_db_cluster_identifierstrsourceDbClusterIdentifierStringSourceDbClusterIdentifierstringSourceDbClusterIdentifier*string#The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster.
notes
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
storageEncryptedboolean | IResolvablestorage_encryptedtyping.Union[bool, IResolvable]storageEncryptedBooleanStorageEncryptedboolStorageEncryptedinterface{}#Indicates whether the global cluster has storage encryption enabled.