Interface: INeptuneGraph

May 8, 2026 · View on GitHub

@cdklabs/generative-ai-cdk-constructs

@cdklabs/generative-ai-cdk-constructs / neptune / INeptuneGraph

Interface: INeptuneGraph

Interface representing a Neptune Graph database.

Properties

env

readonly env: 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.

Inherited from

IResource.env

graphArn

readonly graphArn: string

The Neptune Graph ARN.

Example

'arn:aws:neptune-graph:us-east-1:111122223333:graph/g-12a3bcdef4'

graphEndpoint

readonly graphEndpoint: string

The Neptune Graph endpoint.

Example

'g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com'

graphId

readonly graphId: string

The Neptune Graph Identifier.

Example

'g-12a3bcdef4'

node

readonly node: Node

The tree node.

Inherited from

IResource.node

stack

readonly stack: Stack

The stack in which this resource is defined.

Inherited from

IResource.stack

Methods

applyRemovalPolicy()

applyRemovalPolicy(policy): void

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).

Parameters

policy

RemovalPolicy

Returns

void

Inherited from

IResource.applyRemovalPolicy

createNotebook()

createNotebook(params?): NeptuneGraphNotebook

Creates a Neptune Graph Notebook for the graph. Defaults to a ml.t3.medium instance type. Note: Creating a notebook will incur additional AWS costs for the notebook instance.