Package software.amazon.awscdk.services.rds

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.rds.CfnGlobalCluster
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, IGlobalClusterRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:13.243Z") @Stability(Stable) public class CfnGlobalCluster extends CfnResource implements IInspectable, IGlobalClusterRef, ITaggableV2
The AWS::RDS::GlobalCluster resource creates or updates an Amazon Aurora global database spread across multiple AWS Regions.

The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.

You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it.

For information about Aurora global databases, see Working with Amazon Aurora Global Databases in the Amazon Aurora User Guide .

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.rds.*;
 CfnGlobalCluster cfnGlobalCluster = CfnGlobalCluster.Builder.create(this, "MyCfnGlobalCluster")
         .deletionProtection(false)
         .engine("engine")
         .engineLifecycleSupport("engineLifecycleSupport")
         .engineVersion("engineVersion")
         .globalClusterIdentifier("globalClusterIdentifier")
         .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, @Nullable CfnGlobalClusterProps props)
      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.

    • CfnGlobalCluster

      @Stability(Stable) public CfnGlobalCluster(@NotNull software.constructs.Construct scope, @NotNull String id)
      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.

  • Method Details

    • 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.

    • getAttrGlobalEndpoint

      @Stability(Stable) @NotNull public IResolvable getAttrGlobalEndpoint()

    • 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

    • getDeletionProtection

      @Stability(Stable) @Nullable public Object getDeletionProtection()
      Specifies whether to enable deletion protection for the new global database cluster.

      Returns union: either Boolean or IResolvable

    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable Boolean value)
      Specifies whether to enable deletion protection for the new global database cluster.

    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable IResolvable value)
      Specifies whether to enable deletion protection for the new global database cluster.

    • getEngine

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

    • setEngine

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

    • getEngineLifecycleSupport

      @Stability(Stable) @Nullable public String getEngineLifecycleSupport()
      The life cycle type for this global database cluster.

    • setEngineLifecycleSupport

      @Stability(Stable) public void setEngineLifecycleSupport(@Nullable String value)
      The life cycle type for this global database cluster.

    • getEngineVersion

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

    • setEngineVersion

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

    • getGlobalClusterIdentifier

      @Stability(Stable) @Nullable public String getGlobalClusterIdentifier()
      The cluster identifier for this global database cluster.

    • setGlobalClusterIdentifier

      @Stability(Stable) public void setGlobalClusterIdentifier(@Nullable String value)
      The cluster identifier for this global database cluster.

    • getSourceDbClusterIdentifier

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

    • setSourceDbClusterIdentifier

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

    • getStorageEncrypted

      @Stability(Stable) @Nullable public Object getStorageEncrypted()
      Specifies whether to enable storage encryption for the new global database cluster.

      Returns union: either Boolean or IResolvable

    • setStorageEncrypted

      @Stability(Stable) public void setStorageEncrypted(@Nullable Boolean value)
      Specifies whether to enable storage encryption for the new global database cluster.

    • setStorageEncrypted

      @Stability(Stable) public void setStorageEncrypted(@Nullable IResolvable value)
      Specifies whether to enable storage encryption for the new global database cluster.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.