Package software.amazon.awscdk.services.docdb

Interface CfnGlobalClusterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGlobalClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-19T12:03:52.512Z")
@Stability(Stable)
public interface CfnGlobalClusterProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnGlobalCluster.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.docdb.*;
 CfnGlobalClusterProps cfnGlobalClusterProps = CfnGlobalClusterProps.builder()
         .globalClusterIdentifier("globalClusterIdentifier")
         // the properties below are optional
         .deletionProtection(false)
         .engine("engine")
         .engineVersion("engineVersion")
         .sourceDbClusterIdentifier("sourceDbClusterIdentifier")
         .storageEncrypted(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-globalcluster.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGlobalClusterProps.Builder	A builder for CfnGlobalClusterProps
static final class	CfnGlobalClusterProps.Jsii$Proxy	An implementation for CfnGlobalClusterProps

Method Summary

Modifier and Type	Method	Description
static CfnGlobalClusterProps.Builder	builder()
default Object	getDeletionProtection()	Indicates whether the global cluster has deletion protection enabled.
default String	getEngine()	The database engine to use for this global cluster.
default String	getEngineVersion()	The engine version to use for this global cluster.
String	getGlobalClusterIdentifier()	The cluster identifier of the global cluster.
default String	getSourceDbClusterIdentifier()	The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster.
default Object	getStorageEncrypted()	Indicates whether the global cluster has storage encryption enabled.
default List<CfnTag>	getTags()	The tags to be assigned to the Amazon DocumentDB resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGlobalClusterIdentifier

@Stability(Stable)
@NotNull
String getGlobalClusterIdentifier()

The cluster identifier of the global cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-globalcluster.html#cfn-docdb-globalcluster-globalclusteridentifier

getDeletionProtection

@Stability(Stable)
@Nullable
default Object getDeletionProtection()

Indicates whether the global cluster has deletion protection enabled.

The global cluster can't be deleted when deletion protection is enabled.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-globalcluster.html#cfn-docdb-globalcluster-deletionprotection

getEngine

@Stability(Stable)
@Nullable
default String getEngine()

The database engine to use for this global cluster.

Default: - "docdb"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-globalcluster.html#cfn-docdb-globalcluster-engine

getEngineVersion

@Stability(Stable)
@Nullable
default String getEngineVersion()

The engine version to use for this global cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-globalcluster.html#cfn-docdb-globalcluster-engineversion

getSourceDbClusterIdentifier

@Stability(Stable)
@Nullable
default String getSourceDbClusterIdentifier()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-globalcluster.html#cfn-docdb-globalcluster-sourcedbclusteridentifier

getStorageEncrypted

@Stability(Stable)
@Nullable
default Object getStorageEncrypted()

Indicates whether the global cluster has storage encryption enabled.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-globalcluster.html#cfn-docdb-globalcluster-storageencrypted

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags to be assigned to the Amazon DocumentDB resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-globalcluster.html#cfn-docdb-globalcluster-tags

builder

@Stability(Stable)
static CfnGlobalClusterProps.Builder builder()

Returns:

a CfnGlobalClusterProps.Builder of CfnGlobalClusterProps