Package software.amazon.awscdk.services.neptune

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.neptune.CfnGlobalCluster

All Implemented Interfaces:

IInspectable, IEnvironmentAware, IGlobalClusterRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.133.0 (build 0f43e37)",
           date="2026-06-16T16:14:28.808Z")
@Stability(Stable)
public class CfnGlobalCluster
extends CfnResource
implements IInspectable, IGlobalClusterRef, ITaggableV2

Resource Type definition for AWS::Neptune::GlobalCluster.

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.neptune.*;
 CfnGlobalCluster cfnGlobalCluster = CfnGlobalCluster.Builder.create(this, "MyCfnGlobalCluster")
         .deletionProtection(false)
         .engine("engine")
         .engineVersion("engineVersion")
         .globalClusterIdentifier("globalClusterIdentifier")
         .sourceDbClusterIdentifier("sourceDbClusterIdentifier")
         .storageEncrypted(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-globalcluster.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final 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.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.neptune.IGlobalClusterRef

IGlobalClusterRef.Jsii$Default, IGlobalClusterRef.Jsii$Proxy

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
protected Map<String,String>	getCfnPropertyNames()
Object	getDeletionProtection()	Whether deletion protection is enabled.
String	getEngine()	The name of the database engine.
String	getEngineVersion()	The version number of the database engine.
String	getGlobalClusterIdentifier()	The cluster identifier of the global database cluster.
GlobalClusterReference	getGlobalClusterRef()	A reference to a GlobalCluster resource.
String	getSourceDbClusterIdentifier()	The Amazon Resource Name (ARN) of an existing Neptune DB cluster to use as the primary cluster of the new global database.
Object	getStorageEncrypted()	Whether the global database cluster is storage encrypted.
List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnGlobalCluster(Object x)	Checks whether the given object is a CfnGlobalCluster.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDeletionProtection(Boolean value)	Whether deletion protection is enabled.
void	setDeletionProtection(IResolvable value)	Whether deletion protection is enabled.
void	setEngine(String value)	The name of the database engine.
void	setEngineVersion(String value)	The version number of the database engine.
void	setGlobalClusterIdentifier(String value)	The cluster identifier of the global database cluster.
void	setSourceDbClusterIdentifier(String value)	The Amazon Resource Name (ARN) of an existing Neptune DB cluster to use as the primary cluster of the new global database.
void	setStorageEncrypted(Boolean value)	Whether the global database cluster is storage encrypted.
void	setStorageEncrypted(IResolvable value)	Whether the global database cluster is storage encrypted.
void	setTags(List<CfnTag> value)	An array of key-value pairs to apply to this resource.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyCrossStackReferenceStrength, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, cfnPropertyName, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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, with

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.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnGlobalClusterProps props)

Create a new AWS::Neptune::GlobalCluster.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties.

CfnGlobalCluster

@Stability(Stable)
public CfnGlobalCluster(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Create a new AWS::Neptune::GlobalCluster.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Method Details

isCfnGlobalCluster

@Stability(Stable)
@NotNull
public static Boolean isCfnGlobalCluster(@NotNull
 Object x)

Checks whether the given object is a CfnGlobalCluster.

Parameters:

x - This parameter is required.

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.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCfnPropertyNames

@Stability(Stable)
@NotNull
protected Map<String,String> getCfnPropertyNames()

Overrides:

getCfnPropertyNames in class CfnResource

getGlobalClusterRef

@Stability(Stable)
@NotNull
public GlobalClusterReference getGlobalClusterRef()

A reference to a GlobalCluster resource.

Specified by:

getGlobalClusterRef in interface IGlobalClusterRef

getDeletionProtection

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

Whether deletion protection is enabled.

Returns union: either Boolean or IResolvable

setDeletionProtection

@Stability(Stable)
public void setDeletionProtection(@Nullable
 Boolean value)

Whether deletion protection is enabled.

setDeletionProtection

@Stability(Stable)
public void setDeletionProtection(@Nullable
 IResolvable value)

Whether deletion protection is enabled.

getEngine

@Stability(Stable)
@Nullable
public String getEngine()

The name of the database engine.

setEngine

@Stability(Stable)
public void setEngine(@Nullable
 String value)

The name of the database engine.

getEngineVersion

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

The version number of the database engine.

setEngineVersion

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

The version number of the database engine.

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 Amazon Resource Name (ARN) of an existing Neptune DB cluster to use as the primary cluster of the new global database.

setSourceDbClusterIdentifier

@Stability(Stable)
public void setSourceDbClusterIdentifier(@Nullable
 String value)

The Amazon Resource Name (ARN) of an existing Neptune DB cluster to use as the primary cluster of the new global database.

getStorageEncrypted

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

Whether the global database cluster is storage encrypted.

Returns union: either Boolean or IResolvable

setStorageEncrypted

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

Whether the global database cluster is storage encrypted.

setStorageEncrypted

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

Whether the global database cluster is storage encrypted.

getTags

@Stability(Stable)
@Nullable
public List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

An array of key-value pairs to apply to this resource.