@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-28T21:34:30.422Z") public class CfnGlobalCluster extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnGlobalCluster.Builder
A fluent builder for
CfnGlobalCluster . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnGlobalCluster(Construct scope,
java.lang.String id)
Create a new `AWS::RDS::GlobalCluster`.
|
|
CfnGlobalCluster(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getDeletionProtection()
The deletion protection setting for the new global database.
|
java.lang.String |
getEngine()
The name of the database engine to be used for this DB cluster.
|
java.lang.String |
getEngineVersion()
The engine version of the Aurora global database.
|
java.lang.String |
getGlobalClusterIdentifier()
The cluster identifier of the global database cluster.
|
java.lang.String |
getSourceDbClusterIdentifier()
The DB cluster identifier or Amazon Resource Name (ARN) to use as the primary cluster of the global database.
|
java.lang.Object |
getStorageEncrypted()
The storage encryption setting for the global database cluster.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setDeletionProtection(java.lang.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(java.lang.String value)
The name of the database engine to be used for this DB cluster.
|
void |
setEngineVersion(java.lang.String value)
The engine version of the Aurora global database.
|
void |
setGlobalClusterIdentifier(java.lang.String value)
The cluster identifier of the global database cluster.
|
void |
setSourceDbClusterIdentifier(java.lang.String value)
The DB cluster identifier or Amazon Resource Name (ARN) to use as the primary cluster of the global database.
|
void |
setStorageEncrypted(java.lang.Boolean value)
The storage encryption setting for the global database cluster.
|
void |
setStorageEncrypted(IResolvable value)
The storage encryption setting for the global database cluster.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnGlobalCluster(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnGlobalCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnGlobalCluster(Construct scope, java.lang.String id, CfnGlobalClusterProps props)
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.public CfnGlobalCluster(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.Object getDeletionProtection()
The global database can't be deleted when deletion protection is enabled.
public void setDeletionProtection(java.lang.Boolean value)
The global database can't be deleted when deletion protection is enabled.
public void setDeletionProtection(IResolvable value)
The global database can't be deleted when deletion protection is enabled.
public java.lang.String getEngine()
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 theSourceDBClusterIdentifier
property is specified, make sure this property isn't specified.
public void setEngine(java.lang.String value)
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 theSourceDBClusterIdentifier
property is specified, make sure this property isn't specified.
public java.lang.String getEngineVersion()
public void setEngineVersion(java.lang.String value)
public java.lang.String getGlobalClusterIdentifier()
public void setGlobalClusterIdentifier(java.lang.String value)
public java.lang.String getSourceDbClusterIdentifier()
If the
Engine
property isn't specified, this property is required. If theEngine
property is specified, make sure this property isn't specified.
public void setSourceDbClusterIdentifier(java.lang.String value)
If the
Engine
property isn't specified, this property is required. If theEngine
property is specified, make sure this property isn't specified.
public java.lang.Object getStorageEncrypted()
public void setStorageEncrypted(java.lang.Boolean value)
public void setStorageEncrypted(IResolvable value)