Package software.amazon.awscdk.services.docdb

Class CfnGlobalCluster

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.docdb.CfnGlobalCluster
All Implemented Interfaces:
IInspectable, IGlobalClusterRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)", date="2026-01-19T12:03:52.511Z") @Stability(Stable) public class CfnGlobalCluster extends CfnResource implements IInspectable, IGlobalClusterRef, ITaggableV2
The AWS::DocDB::GlobalCluster resource represents an Amazon DocumentDB Global Cluster.

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.*;
 CfnGlobalCluster cfnGlobalCluster = CfnGlobalCluster.Builder.create(this, "MyCfnGlobalCluster")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnGlobalCluster

      protected CfnGlobalCluster(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnGlobalCluster

      protected CfnGlobalCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnGlobalCluster

      @Stability(Stable) public CfnGlobalCluster(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnGlobalClusterProps props)
      Create a new AWS::DocDB::GlobalCluster.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForGlobalCluster

      @Stability(Stable) @NotNull public static String arnForGlobalCluster(@NotNull IGlobalClusterRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnGlobalCluster

      @Stability(Stable) @NotNull public static Boolean isCfnGlobalCluster(@NotNull Object x)
      Checks whether the given object is a CfnGlobalCluster.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrGlobalClusterArn

      @Stability(Stable) @NotNull public String getAttrGlobalClusterArn()
      The Amazon Resource Name (ARN) for the global cluster.

    • getAttrGlobalClusterResourceId

      @Stability(Stable) @NotNull public String getAttrGlobalClusterResourceId()
      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.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getGlobalClusterRef

      @Stability(Stable) @NotNull public GlobalClusterReference getGlobalClusterRef()
      A reference to a GlobalCluster resource.
      Specified by:
      getGlobalClusterRef in interface IGlobalClusterRef

    • getGlobalClusterIdentifier

      @Stability(Stable) @NotNull public String getGlobalClusterIdentifier()
      The cluster identifier of the global cluster.

    • setGlobalClusterIdentifier

      @Stability(Stable) public void setGlobalClusterIdentifier(@NotNull String value)
      The cluster identifier of the global cluster.

    • getDeletionProtection

      @Stability(Stable) @Nullable public Object getDeletionProtection()
      Indicates whether the global cluster has deletion protection enabled.

      Returns union: either Boolean or IResolvable

    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable Boolean value)
      Indicates whether the global cluster has deletion protection enabled.

    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable IResolvable value)
      Indicates whether the global cluster has deletion protection enabled.

    • getEngine

      @Stability(Stable) @Nullable public String getEngine()
      The database engine to use for this global cluster.

    • setEngine

      @Stability(Stable) public void setEngine(@Nullable String value)
      The database engine to use for this global cluster.

    • getEngineVersion

      @Stability(Stable) @Nullable public String getEngineVersion()
      The engine version to use for this global cluster.

    • setEngineVersion

      @Stability(Stable) public void setEngineVersion(@Nullable String value)
      The engine version to use for this global cluster.

    • getSourceDbClusterIdentifier

      @Stability(Stable) @Nullable public String getSourceDbClusterIdentifier()
      The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster.

    • setSourceDbClusterIdentifier

      @Stability(Stable) public void setSourceDbClusterIdentifier(@Nullable String value)
      The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster.

    • getStorageEncrypted

      @Stability(Stable) @Nullable public Object getStorageEncrypted()
      Indicates whether the global cluster has storage encryption enabled.

      Returns union: either Boolean or IResolvable

    • setStorageEncrypted

      @Stability(Stable) public void setStorageEncrypted(@Nullable Boolean value)
      Indicates whether the global cluster has storage encryption enabled.

    • setStorageEncrypted

      @Stability(Stable) public void setStorageEncrypted(@Nullable IResolvable value)
      Indicates whether the global cluster has storage encryption enabled.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags to be assigned to the Amazon DocumentDB resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags to be assigned to the Amazon DocumentDB resource.