Package software.amazon.awscdk.services.neptune

Interface CfnDBInstanceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDBInstanceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:40.677Z")
@Stability(Stable)
public interface CfnDBInstanceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDBInstance.

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.*;
 CfnDBInstanceProps cfnDBInstanceProps = CfnDBInstanceProps.builder()
         .dbInstanceClass("dbInstanceClass")
         // the properties below are optional
         .allowMajorVersionUpgrade(false)
         .autoMinorVersionUpgrade(false)
         .availabilityZone("availabilityZone")
         .dbClusterIdentifier("dbClusterIdentifier")
         .dbInstanceIdentifier("dbInstanceIdentifier")
         .dbParameterGroupName("dbParameterGroupName")
         .dbSnapshotIdentifier("dbSnapshotIdentifier")
         .dbSubnetGroupName("dbSubnetGroupName")
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .publiclyAccessible(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-dbinstance.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDBInstanceProps.Builder	builder()
default Object	getAllowMajorVersionUpgrade()	Indicates that major version upgrades are allowed.
default Object	getAutoMinorVersionUpgrade()	Indicates that minor version patches are applied automatically.
default String	getAvailabilityZone()	Specifies the name of the Availability Zone the DB instance is located in.
default String	getDbClusterIdentifier()	If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
String	getDbInstanceClass()	Contains the name of the compute and memory capacity class of the DB instance.
default String	getDbInstanceIdentifier()	Contains a user-supplied database identifier.
default String	getDbParameterGroupName()	The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template.
default String	getDbSnapshotIdentifier()	Deprecated. this property has been deprecated
default String	getDbSubnetGroupName()	A DB subnet group to associate with the DB instance.
default String	getPreferredMaintenanceWindow()	Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
default Object	getPubliclyAccessible()	Indicates whether the DB instance is publicly accessible.
default List<CfnTag>	getTags()	An arbitrary set of tags (key-value pairs) for this DB instance.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDbInstanceClass

@Stability(Stable)
@NotNull
String getDbInstanceClass()

Contains the name of the compute and memory capacity class of the DB instance.

If you update this property, some interruptions may occur.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbinstanceclass

getAllowMajorVersionUpgrade

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

Indicates that major version upgrades are allowed.

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

When you change this parameter for an existing DB cluster, CloudFormation will replace your existing DB cluster with a new, empty one that uses the engine version you specified.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-allowmajorversionupgrade

getAutoMinorVersionUpgrade

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

Indicates that minor version patches are applied automatically.

When updating this property, some interruptions may occur.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-autominorversionupgrade

getAvailabilityZone

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

Specifies the name of the Availability Zone the DB instance is located in.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-availabilityzone

getDbClusterIdentifier

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

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbclusteridentifier

getDbInstanceIdentifier

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

Contains a user-supplied database identifier.

This identifier is the unique key that identifies a DB instance.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbinstanceidentifier

getDbParameterGroupName

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

The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template.

If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbparametergroupname

getDbSnapshotIdentifier

@Stability(Deprecated)
@Deprecated
@Nullable
default String getDbSnapshotIdentifier()

Deprecated.

this property has been deprecated

(deprecated) This parameter is not supported.

AWS::Neptune::DBInstance does not support restoring from snapshots.

AWS::Neptune::DBCluster does support restoring from snapshots.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbsnapshotidentifier

getDbSubnetGroupName

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

A DB subnet group to associate with the DB instance.

If you update this value, the new subnet group must be a subnet group in a new virtual private cloud (VPC).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbsubnetgroupname

getPreferredMaintenanceWindow

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

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-preferredmaintenancewindow

getPubliclyAccessible

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

Indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-publiclyaccessible

getTags

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

An arbitrary set of tags (key-value pairs) for this DB instance.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-tags

builder

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

Returns:

a CfnDBInstanceProps.Builder of CfnDBInstanceProps