class DatabaseInstanceBase 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Neptune.Alpha.DatabaseInstanceBase
Go	github.com/aws/aws-cdk-go/awscdkneptunealpha/v2#DatabaseInstanceBase
Java	software.amazon.awscdk.services.neptune.alpha.DatabaseInstanceBase
Python	aws_cdk.aws_neptune_alpha.DatabaseInstanceBase
TypeScript (source)	@aws-cdk/aws-neptune-alpha » DatabaseInstanceBase

Implements IConstruct, IDependable, IResource, IEnvironmentAware, IDatabaseInstance

Extends Resource

Implemented by DatabaseInstance

A new or imported database instance.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as neptune_alpha from '@aws-cdk/aws-neptune-alpha';
const databaseInstanceBase = neptune_alpha.DatabaseInstanceBase.fromDatabaseInstanceAttributes(this, 'MyDatabaseInstanceBase', {
  instanceEndpointAddress: 'instanceEndpointAddress',
  instanceIdentifier: 'instanceIdentifier',
  port: 123,
});

Initializer

new DatabaseInstanceBase(scope: Construct, id: string, props?: ResourceProps)

Parameters

• scope Construct
• id string
• props ResourceProps

Properties

Name	Type	Description
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🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.

---

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 in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

instanceEndpoint🔹

Type: Endpoint

The instance endpoint.

---

instanceIdentifier🔹

Type: string

The instance identifier.

---

node🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
metric(metricName, props?)🔹	Return the given named metric associated with this database instance.
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).

---

metric(metricName, props?)🔹

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

• metricName string
• props MetricOptions

Returns

• Metric

Return the given named metric associated with this database instance.

---

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.