Package software.amazon.awscdk.services.rds

Class CfnGlobalCluster

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.rds.CfnGlobalCluster
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:49.068Z") @Stability(Stable) public class CfnGlobalCluster extends CfnResource implements IInspectable
A CloudFormation AWS::RDS::GlobalCluster.

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")
         .engineVersion("engineVersion")
         .globalClusterIdentifier("globalClusterIdentifier")
         .sourceDbClusterIdentifier("sourceDbClusterIdentifier")
         .storageEncrypted(false)
         .build();

  • 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 Construct scope, @NotNull String id, @Nullable CfnGlobalClusterProps props)
      Create a new AWS::RDS::GlobalCluster.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnGlobalCluster

      @Stability(Stable) public CfnGlobalCluster(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::RDS::GlobalCluster.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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.

    • getCfnProperties

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

    • getDeletionProtection

      @Stability(Stable) @Nullable public Object getDeletionProtection()
      The deletion protection setting for the new global database.

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

    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable Boolean value)
      The deletion protection setting for the new global database.

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

    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable IResolvable value)
      The deletion protection setting for the new global database.

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

    • getEngine

      @Stability(Stable) @Nullable public String getEngine()
      The name of the database engine to be used for this DB cluster.

      If this property isn't specified, the database engine is derived from the source DB cluster specified by the SourceDBClusterIdentifier property.

      If the SourceDBClusterIdentifier property isn't specified, this property is required. If the SourceDBClusterIdentifier property is specified, make sure this property isn't specified.

    • setEngine

      @Stability(Stable) public void setEngine(@Nullable String value)
      The name of the database engine to be used for this DB cluster.

      If this property isn't specified, the database engine is derived from the source DB cluster specified by the SourceDBClusterIdentifier property.

      If the SourceDBClusterIdentifier property isn't specified, this property is required. If the SourceDBClusterIdentifier property is specified, make sure this property isn't specified.

    • getEngineVersion

      @Stability(Stable) @Nullable public String getEngineVersion()
      The engine version of the Aurora global database.

    • setEngineVersion

      @Stability(Stable) public void setEngineVersion(@Nullable String value)
      The engine version of the Aurora global database.

    • getGlobalClusterIdentifier

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

    • setGlobalClusterIdentifier

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

    • getSourceDbClusterIdentifier

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

      If the Engine property isn't specified, this property is required. If the Engine property is specified, make sure this property isn't specified.

    • setSourceDbClusterIdentifier

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

      If the Engine property isn't specified, this property is required. If the Engine property is specified, make sure this property isn't specified.

    • getStorageEncrypted

      @Stability(Stable) @Nullable public Object getStorageEncrypted()
      The storage encryption setting for the global database cluster.

    • setStorageEncrypted

      @Stability(Stable) public void setStorageEncrypted(@Nullable Boolean value)
      The storage encryption setting for the global database cluster.

    • setStorageEncrypted

      @Stability(Stable) public void setStorageEncrypted(@Nullable IResolvable value)
      The storage encryption setting for the global database cluster.