Skip to content
v2.274.0

Experimental

@aws-cdk/aws-neptune-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

DatabaseInstanceProps Struct ​

Construction properties for a DatabaseInstanceNew.

Example ​

ts
const replica1 = new neptune.DatabaseInstance(this, 'Instance', {
  cluster,
  instanceType: neptune.InstanceType.R5_LARGE,
});

Properties ​

autoMinorVersionUpgradeoptionalbooleanauto_minor_version_upgradeoptionalboolautoMinorVersionUpgradeoptionalBooleanAutoMinorVersionUpgradeoptionalboolAutoMinorVersionUpgradeoptional*bool= undefined#
Indicates that minor version patches are applied automatically.
availabilityZoneoptionalstringavailability_zoneoptionalstravailabilityZoneoptionalStringAvailabilityZoneoptionalstringAvailabilityZoneoptional*string#
The name of the Availability Zone where the DB instance will be located.

Default: no preference

The Neptune database cluster the instance should launch into.
dbInstanceNameoptionalstringdb_instance_nameoptionalstrdbInstanceNameoptionalStringDbInstanceNameoptionalstringDbInstanceNameoptional*string#
A name for the DB instance.

Default: a CloudFormation generated name

If you specify a name, AWS CloudFormation converts it to lowercase.

instanceTypeInstanceTypeinstance_typeInstanceTypeinstanceTypeInstanceTypeInstanceTypeInstanceTypeInstanceTypeInstanceTyperequired#
What type of instance to start for the replicas.
parameterGroupoptionalIParameterGroupparameter_groupoptionalIParameterGroupparameterGroupoptionalIParameterGroupParameterGroupoptionalIParameterGroupParameterGroupoptionalIParameterGroup#
The DB parameter group to associate with the instance.

Default: no parameter group

removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy= RemovalPolicy.Retain#
The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.