Package software.amazon.awscdk.services.rds

Interface CfnGlobalClusterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGlobalClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:49.070Z")
@Stability(Stable)
public interface CfnGlobalClusterProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnGlobalCluster.

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.*;
 CfnGlobalClusterProps cfnGlobalClusterProps = CfnGlobalClusterProps.builder()
         .deletionProtection(false)
         .engine("engine")
         .engineVersion("engineVersion")
         .globalClusterIdentifier("globalClusterIdentifier")
         .sourceDbClusterIdentifier("sourceDbClusterIdentifier")
         .storageEncrypted(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGlobalClusterProps.Builder	A builder for CfnGlobalClusterProps
static final class	CfnGlobalClusterProps.Jsii$Proxy	An implementation for CfnGlobalClusterProps

Method Summary

Modifier and Type	Method	Description
static CfnGlobalClusterProps.Builder	builder()
default Object	getDeletionProtection()	The deletion protection setting for the new global database.
default String	getEngine()	The name of the database engine to be used for this DB cluster.
default String	getEngineVersion()	The engine version of the Aurora global database.
default String	getGlobalClusterIdentifier()	The cluster identifier of the global database cluster.
default String	getSourceDbClusterIdentifier()	The DB cluster identifier or Amazon Resource Name (ARN) to use as the primary cluster of the global database.
default Object	getStorageEncrypted()	The storage encryption setting for the global database cluster.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeletionProtection

@Stability(Stable)
@Nullable
default Object getDeletionProtection()

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

getEngineVersion

@Stability(Stable)
@Nullable
default String getEngineVersion()

The engine version of the Aurora global database.

getGlobalClusterIdentifier

@Stability(Stable)
@Nullable
default String getGlobalClusterIdentifier()

The cluster identifier of the global database cluster.

getSourceDbClusterIdentifier

@Stability(Stable)
@Nullable
default 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.

getStorageEncrypted

@Stability(Stable)
@Nullable
default Object getStorageEncrypted()

The storage encryption setting for the global database cluster.

builder

@Stability(Stable)
static CfnGlobalClusterProps.Builder builder()

Returns:

a CfnGlobalClusterProps.Builder of CfnGlobalClusterProps