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:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.427Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnGlobalCluster.Builder A fluent builder for CfnGlobalCluster.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnGlobalCluster(software.constructs.Construct scope, String id) Create a new `AWS::RDS::GlobalCluster`.
	CfnGlobalCluster(software.constructs.Construct scope, String id, CfnGlobalClusterProps props) Create a new `AWS::RDS::GlobalCluster`.
protected	CfnGlobalCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnGlobalCluster(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
Object	getDeletionProtection() The deletion protection setting for the new global database.
String	getEngine() The name of the database engine to be used for this DB cluster.
String	getEngineVersion() The engine version of the Aurora global database.
String	getGlobalClusterIdentifier() The cluster identifier of the global database cluster.
String	getSourceDbClusterIdentifier() The DB cluster identifier or Amazon Resource Name (ARN) to use as the primary cluster of the global database.
Object	getStorageEncrypted() The storage encryption setting for the global database cluster.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDeletionProtection(Boolean value) The deletion protection setting for the new global database.
void	setDeletionProtection(IResolvable value) The deletion protection setting for the new global database.
void	setEngine(String value) The name of the database engine to be used for this DB cluster.
void	setEngineVersion(String value) The engine version of the Aurora global database.
void	setGlobalClusterIdentifier(String value) The cluster identifier of the global database cluster.
void	setSourceDbClusterIdentifier(String value) The DB cluster identifier or Amazon Resource Name (ARN) to use as the primary cluster of the global database.
void	setStorageEncrypted(Boolean value) The storage encryption setting for the global database cluster.
void	setStorageEncrypted(IResolvable value) The storage encryption setting for the global database cluster.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnGlobalCluster

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

CfnGlobalCluster

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

CfnGlobalCluster

@Stability(value=Stable)
public CfnGlobalCluster(@NotNull
                                                 software.constructs.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(value=Stable)
public CfnGlobalCluster(@NotNull
                                                 software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDeletionProtection

@Stability(value=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(value=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(value=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(value=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(value=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(value=Stable)
 @Nullable
public String getEngineVersion()

The engine version of the Aurora global database.

setEngineVersion

@Stability(value=Stable)
public void setEngineVersion(@Nullable
                                                      String value)

The engine version of the Aurora global database.

getGlobalClusterIdentifier

@Stability(value=Stable)
 @Nullable
public String getGlobalClusterIdentifier()

The cluster identifier of the global database cluster.

setGlobalClusterIdentifier

@Stability(value=Stable)
public void setGlobalClusterIdentifier(@Nullable
                                                                String value)

The cluster identifier of the global database cluster.

getSourceDbClusterIdentifier

@Stability(value=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(value=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(value=Stable)
 @Nullable
public Object getStorageEncrypted()

The storage encryption setting for the global database cluster.

setStorageEncrypted

@Stability(value=Stable)
public void setStorageEncrypted(@Nullable
                                                         Boolean value)

The storage encryption setting for the global database cluster.

setStorageEncrypted

@Stability(value=Stable)
public void setStorageEncrypted(@Nullable
                                                         IResolvable value)

The storage encryption setting for the global database cluster.