class DatabaseInstance (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Neptune.DatabaseInstance
Java	software.amazon.awscdk.services.neptune.DatabaseInstance
Python	aws_cdk.aws_neptune.DatabaseInstance
TypeScript (source)	@aws-cdk/aws-neptune » DatabaseInstance

Implements IConstruct, IConstruct, IDependable, IResource, IDatabaseInstance

A database instance.

Example

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

Initializer

new DatabaseInstance(scope: Construct, id: string, props: DatabaseInstanceProps)

Parameters

• scope Construct
• id string
• props DatabaseInstanceProps

Construct Props

Name	Type	Description
cluster🔹	IDatabaseCluster	The Neptune database cluster the instance should launch into.
instanceType🔹	InstanceType	What type of instance to start for the replicas.
availabilityZone?🔹	string	The name of the Availability Zone where the DB instance will be located.
dbInstanceName?🔹	string	A name for the DB instance.
parameterGroup?🔹	IParameterGroup	The DB parameter group to associate with the instance.
removalPolicy?🔹	RemovalPolicy	The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.

---

cluster🔹

Type: IDatabaseCluster

The Neptune database cluster the instance should launch into.

---

instanceType🔹

Type: InstanceType

What type of instance to start for the replicas.

---

availabilityZone?🔹

Type: string (optional, default: no preference)

The name of the Availability Zone where the DB instance will be located.

---

dbInstanceName?🔹

Type: string (optional, default: a CloudFormation generated name)

A name for the DB instance.

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

---

parameterGroup?🔹

Type: IParameterGroup (optional, default: no parameter group)

The DB parameter group to associate with the instance.

---

removalPolicy?🔹

Type: RemovalPolicy (optional, default: RemovalPolicy.Retain)

The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.

Properties

Name	Type	Description
cluster🔹	IDatabaseCluster	The instance's database cluster.
dbInstanceEndpointAddress🔹	string	The instance endpoint address.
dbInstanceEndpointPort🔹	string	The instance endpoint port.
env🔹	ResourceEnvironment	The environment this resource belongs to.
instanceEndpoint🔹	Endpoint	The instance endpoint.
instanceIdentifier🔹	string	The instance identifier.
node🔹	ConstructNode	The construct tree node associated with this construct.
stack🔹	Stack	The stack in which this resource is defined.

---

cluster🔹

Type: IDatabaseCluster

The instance's database cluster.

---

dbInstanceEndpointAddress🔹

Type: string

The instance endpoint address.

---

dbInstanceEndpointPort🔹

Type: string

The instance endpoint port.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

instanceEndpoint🔹

Type: Endpoint

The instance endpoint.

---

instanceIdentifier🔹

Type: string

The instance identifier.

---

node🔹

Type: ConstructNode

The construct tree node associated with this construct.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
toString()🔹	Returns a string representation of this construct.
static fromDatabaseInstanceAttributes(scope, id, attrs)🔹	Import an existing database instance.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromDatabaseInstanceAttributes(scope, id, attrs)🔹

public static fromDatabaseInstanceAttributes(scope: Construct, id: string, attrs: DatabaseInstanceAttributes): IDatabaseInstance

Parameters

• scope Construct
• id string
• attrs DatabaseInstanceAttributes

Returns

• IDatabaseInstance

Import an existing database instance.