Class CfnGlobalCluster
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
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/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionCfnGlobalCluster
(Construct scope, String id) Create a newAWS::RDS::GlobalCluster
.CfnGlobalCluster
(Construct scope, String id, CfnGlobalClusterProps props) Create a newAWS::RDS::GlobalCluster
.protected
CfnGlobalCluster
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnGlobalCluster
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe deletion protection setting for the new global database.The name of the database engine to be used for this DB cluster.The engine version of the Aurora global database.The cluster identifier of the global database cluster.The DB cluster identifier or Amazon Resource Name (ARN) to use as the primary cluster of the global database.The storage encryption setting for the global database cluster.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.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
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
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.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
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 Details
-
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 newAWS::RDS::GlobalCluster
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
CfnGlobalCluster
Create a newAWS::RDS::GlobalCluster
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getDeletionProtection
The deletion protection setting for the new global database.The global database can't be deleted when deletion protection is enabled.
-
setDeletionProtection
The deletion protection setting for the new global database.The global database can't be deleted when deletion protection is enabled.
-
setDeletionProtection
The deletion protection setting for the new global database.The global database can't be deleted when deletion protection is enabled.
-
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 theSourceDBClusterIdentifier
property is specified, make sure this property isn't specified. -
setEngine
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 theSourceDBClusterIdentifier
property is specified, make sure this property isn't specified. -
getEngineVersion
The engine version of the Aurora global database. -
setEngineVersion
The engine version of the Aurora global database. -
getGlobalClusterIdentifier
The cluster identifier of the global database cluster. -
setGlobalClusterIdentifier
The cluster identifier of the global database cluster. -
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 theEngine
property is specified, make sure this property isn't specified. -
setSourceDbClusterIdentifier
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 theEngine
property is specified, make sure this property isn't specified. -
getStorageEncrypted
The storage encryption setting for the global database cluster. -
setStorageEncrypted
The storage encryption setting for the global database cluster. -
setStorageEncrypted
The storage encryption setting for the global database cluster.
-