Package software.amazon.awscdk.services.neptune

Class CfnDBCluster

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.CfnDBCluster
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IDBClusterRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:40.667Z") @Stability(Stable) public class CfnDBCluster extends CfnResource implements IInspectable, IDBClusterRef, ITaggable
The AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster. Neptune is a fully managed graph database.

Currently, you can create this resource only in AWS Regions in which Amazon Neptune is supported.

If no DeletionPolicy is set for AWS::Neptune::DBCluster resources, the default deletion behavior is that the entire volume will be deleted without a snapshot. To retain a backup of the volume, the DeletionPolicy should be set to Snapshot . For more information about how CloudFormation deletes resources, see DeletionPolicy Attribute .

You can use AWS::Neptune::DBCluster.DeletionProtection to help guard against unintended deletion of your DB cluster.

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.*;
 CfnDBCluster cfnDBCluster = CfnDBCluster.Builder.create(this, "MyCfnDBCluster")
         .associatedRoles(List.of(DBClusterRoleProperty.builder()
                 .roleArn("roleArn")
                 // the properties below are optional
                 .featureName("featureName")
                 .build()))
         .availabilityZones(List.of("availabilityZones"))
         .backupRetentionPeriod(123)
         .copyTagsToSnapshot(false)
         .dbClusterIdentifier("dbClusterIdentifier")
         .dbClusterParameterGroupName("dbClusterParameterGroupName")
         .dbInstanceParameterGroupName("dbInstanceParameterGroupName")
         .dbPort(123)
         .dbSubnetGroupName("dbSubnetGroupName")
         .deletionProtection(false)
         .enableCloudwatchLogsExports(List.of("enableCloudwatchLogsExports"))
         .engineVersion("engineVersion")
         .iamAuthEnabled(false)
         .kmsKeyId("kmsKeyId")
         .preferredBackupWindow("preferredBackupWindow")
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .restoreToTime("restoreToTime")
         .restoreType("restoreType")
         .serverlessScalingConfiguration(ServerlessScalingConfigurationProperty.builder()
                 .maxCapacity(123)
                 .minCapacity(123)
                 .build())
         .snapshotIdentifier("snapshotIdentifier")
         .sourceDbClusterIdentifier("sourceDbClusterIdentifier")
         .storageEncrypted(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .useLatestRestorableTime(false)
         .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
         .build();

See Also:

  • 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

    • CfnDBCluster

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

    • CfnDBCluster

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

    • CfnDBCluster

      @Stability(Stable) public CfnDBCluster(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnDBClusterProps props)
      Create a new AWS::Neptune::DBCluster.

      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.

    • CfnDBCluster

      @Stability(Stable) public CfnDBCluster(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::Neptune::DBCluster.

      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

    • isCfnDBCluster

      @Stability(Stable) @NotNull public static Boolean isCfnDBCluster(@NotNull Object x)
      Checks whether the given object is a CfnDBCluster.

      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.

    • getAttrClusterResourceId

      @Stability(Stable) @NotNull public String getAttrClusterResourceId()
      The resource id for the DB cluster.

      For example: cluster-ABCD1234EFGH5678IJKL90MNOP . The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.

    • getAttrEndpoint

      @Stability(Stable) @NotNull public String getAttrEndpoint()
      The connection endpoint for the DB cluster.

      For example: mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com

    • getAttrPort

      @Stability(Stable) @NotNull public String getAttrPort()
      The port number on which the DB instances in the DB cluster accept connections.

    • getAttrReadEndpoint

      @Stability(Stable) @NotNull public String getAttrReadEndpoint()
      The reader endpoint for the DB cluster.

      For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDbClusterRef

      @Stability(Stable) @NotNull public DBClusterReference getDbClusterRef()
      A reference to a DBCluster resource.
      Specified by:
      getDbClusterRef in interface IDBClusterRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAssociatedRoles

      @Stability(Stable) @Nullable public Object getAssociatedRoles()
      Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDBCluster.DBClusterRoleProperty>

    • setAssociatedRoles

      @Stability(Stable) public void setAssociatedRoles(@Nullable IResolvable value)
      Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster.

    • setAssociatedRoles

      @Stability(Stable) public void setAssociatedRoles(@Nullable List<Object> value)
      Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster.

    • getAvailabilityZones

      @Stability(Stable) @Nullable public List<String> getAvailabilityZones()
      Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

    • setAvailabilityZones

      @Stability(Stable) public void setAvailabilityZones(@Nullable List<String> value)
      Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

    • getBackupRetentionPeriod

      @Stability(Stable) @Nullable public Number getBackupRetentionPeriod()
      Specifies the number of days for which automatic DB snapshots are retained.

    • setBackupRetentionPeriod

      @Stability(Stable) public void setBackupRetentionPeriod(@Nullable Number value)
      Specifies the number of days for which automatic DB snapshots are retained.

    • getCopyTagsToSnapshot

      @Stability(Stable) @Nullable public Object getCopyTagsToSnapshot()
      If set to true , tags are copied to any snapshot of the DB cluster that is created..

      Returns union: either Boolean or IResolvable

    • setCopyTagsToSnapshot

      @Stability(Stable) public void setCopyTagsToSnapshot(@Nullable Boolean value)
      If set to true , tags are copied to any snapshot of the DB cluster that is created..

    • setCopyTagsToSnapshot

      @Stability(Stable) public void setCopyTagsToSnapshot(@Nullable IResolvable value)
      If set to true , tags are copied to any snapshot of the DB cluster that is created..

    • getDbClusterIdentifier

      @Stability(Stable) @Nullable public String getDbClusterIdentifier()
      Contains a user-supplied DB cluster identifier.

    • setDbClusterIdentifier

      @Stability(Stable) public void setDbClusterIdentifier(@Nullable String value)
      Contains a user-supplied DB cluster identifier.

    • getDbClusterParameterGroupName

      @Stability(Stable) @Nullable public String getDbClusterParameterGroupName()
      Provides the name of the DB cluster parameter group.

    • setDbClusterParameterGroupName

      @Stability(Stable) public void setDbClusterParameterGroupName(@Nullable String value)
      Provides the name of the DB cluster parameter group.

    • getDbInstanceParameterGroupName

      @Stability(Stable) @Nullable public String getDbInstanceParameterGroupName()
      The name of the DB parameter group to apply to all instances of the DB cluster.

    • setDbInstanceParameterGroupName

      @Stability(Stable) public void setDbInstanceParameterGroupName(@Nullable String value)
      The name of the DB parameter group to apply to all instances of the DB cluster.

    • getDbPort

      @Stability(Stable) @Nullable public Number getDbPort()
      The port number on which the DB instances in the DB cluster accept connections.

    • setDbPort

      @Stability(Stable) public void setDbPort(@Nullable Number value)
      The port number on which the DB instances in the DB cluster accept connections.

    • getDbSubnetGroupName

      @Stability(Stable) @Nullable public String getDbSubnetGroupName()
      Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

    • setDbSubnetGroupName

      @Stability(Stable) public void setDbSubnetGroupName(@Nullable String value)
      Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

    • getDeletionProtection

      @Stability(Stable) @Nullable public Object getDeletionProtection()
      Indicates whether or not the DB cluster has deletion protection enabled.

      Returns union: either Boolean or IResolvable

    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable Boolean value)
      Indicates whether or not the DB cluster has deletion protection enabled.

    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable IResolvable value)
      Indicates whether or not the DB cluster has deletion protection enabled.

    • getEnableCloudwatchLogsExports

      @Stability(Stable) @Nullable public List<String> getEnableCloudwatchLogsExports()
      Specifies a list of log types that are enabled for export to CloudWatch Logs.

    • setEnableCloudwatchLogsExports

      @Stability(Stable) public void setEnableCloudwatchLogsExports(@Nullable List<String> value)
      Specifies a list of log types that are enabled for export to CloudWatch Logs.

    • getEngineVersion

      @Stability(Stable) @Nullable public String getEngineVersion()
      Indicates the database engine version.

    • setEngineVersion

      @Stability(Stable) public void setEngineVersion(@Nullable String value)
      Indicates the database engine version.

    • getIamAuthEnabled

      @Stability(Stable) @Nullable public Object getIamAuthEnabled()
      True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

      Returns union: either Boolean or IResolvable

    • setIamAuthEnabled

      @Stability(Stable) public void setIamAuthEnabled(@Nullable Boolean value)
      True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    • setIamAuthEnabled

      @Stability(Stable) public void setIamAuthEnabled(@Nullable IResolvable value)
      True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef .

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef .

    • getPreferredBackupWindow

      @Stability(Stable) @Nullable public String getPreferredBackupWindow()
      Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .

    • setPreferredBackupWindow

      @Stability(Stable) public void setPreferredBackupWindow(@Nullable String value)
      Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .

    • getPreferredMaintenanceWindow

      @Stability(Stable) @Nullable public String getPreferredMaintenanceWindow()
      Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    • setPreferredMaintenanceWindow

      @Stability(Stable) public void setPreferredMaintenanceWindow(@Nullable String value)
      Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    • getRestoreToTime

      @Stability(Stable) @Nullable public String getRestoreToTime()
      Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

    • setRestoreToTime

      @Stability(Stable) public void setRestoreToTime(@Nullable String value)
      Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

    • getRestoreType

      @Stability(Stable) @Nullable public String getRestoreType()
      Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

    • setRestoreType

      @Stability(Stable) public void setRestoreType(@Nullable String value)
      Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

    • getServerlessScalingConfiguration

      @Stability(Stable) @Nullable public Object getServerlessScalingConfiguration()
      Contains the scaling configuration of an Neptune Serverless DB cluster.

      Returns union: either IResolvable or CfnDBCluster.ServerlessScalingConfigurationProperty

    • setServerlessScalingConfiguration

      @Stability(Stable) public void setServerlessScalingConfiguration(@Nullable IResolvable value)
      Contains the scaling configuration of an Neptune Serverless DB cluster.

    • setServerlessScalingConfiguration

      @Stability(Stable) public void setServerlessScalingConfiguration(@Nullable CfnDBCluster.ServerlessScalingConfigurationProperty value)
      Contains the scaling configuration of an Neptune Serverless DB cluster.

    • getSnapshotIdentifier

      @Stability(Stable) @Nullable public String getSnapshotIdentifier()
      Specifies the identifier for a DB cluster snapshot.

      Must match the identifier of an existing snapshot.

    • setSnapshotIdentifier

      @Stability(Stable) public void setSnapshotIdentifier(@Nullable String value)
      Specifies the identifier for a DB cluster snapshot.

      Must match the identifier of an existing snapshot.

    • getSourceDbClusterIdentifier

      @Stability(Stable) @Nullable public String getSourceDbClusterIdentifier()
      Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

    • setSourceDbClusterIdentifier

      @Stability(Stable) public void setSourceDbClusterIdentifier(@Nullable String value)
      Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

    • getStorageEncrypted

      @Stability(Stable) @Nullable public Object getStorageEncrypted()
      Indicates whether the DB cluster is encrypted.

      Returns union: either Boolean or IResolvable

    • setStorageEncrypted

      @Stability(Stable) public void setStorageEncrypted(@Nullable Boolean value)
      Indicates whether the DB cluster is encrypted.

    • setStorageEncrypted

      @Stability(Stable) public void setStorageEncrypted(@Nullable IResolvable value)
      Indicates whether the DB cluster is encrypted.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags assigned to this cluster.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags assigned to this cluster.

    • getUseLatestRestorableTime

      @Stability(Stable) @Nullable public Object getUseLatestRestorableTime()
      Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

      Returns union: either Boolean or IResolvable

    • setUseLatestRestorableTime

      @Stability(Stable) public void setUseLatestRestorableTime(@Nullable Boolean value)
      Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

    • setUseLatestRestorableTime

      @Stability(Stable) public void setUseLatestRestorableTime(@Nullable IResolvable value)
      Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

    • getVpcSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> getVpcSecurityGroupIds()
      Provides a list of VPC security groups that the DB cluster belongs to.

    • setVpcSecurityGroupIds

      @Stability(Stable) public void setVpcSecurityGroupIds(@Nullable List<String> value)
      Provides a list of VPC security groups that the DB cluster belongs to.