generative-ai-cdk-constructs

@cdklabs/generative-ai-cdk-constructs

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

Class: abstract NeptuneGraphBase

Abstract base class for a Neptune Graph. Contains methods and attributes valid for Graphs either created with CDK or imported.

Extends

Extended by

Implements

Constructors

Constructor

new NeptuneGraphBase(scope, id, props?): NeptuneGraphBase

Parameters

scope

Construct

id

string

props?

ResourceProps

Returns

NeptuneGraphBase

Inherited from

Resource.constructor

Properties

env

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

Implementation of

INeptuneGraph.env

Inherited from

Resource.env

graphArn

abstract readonly graphArn: string

The Neptune Graph ARN.

Example

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

Implementation of

INeptuneGraph.graphArn

graphEndpoint

abstract readonly graphEndpoint: string

The Neptune Graph endpoint.

Example

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

Implementation of

INeptuneGraph.graphEndpoint

graphId

abstract readonly graphId: string

The Neptune Graph Identifier.

Example

'g-12a3bcdef4'

Implementation of

INeptuneGraph.graphId

node

readonly node: Node

The tree node.

Implementation of

INeptuneGraph.node

Inherited from

Resource.node

physicalName

protected readonly physicalName: string

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

Inherited from

Resource.physicalName

stack

readonly stack: Stack

The stack in which this resource is defined.

Implementation of

INeptuneGraph.stack

Inherited from

Resource.stack

Methods

_enableCrossEnvironment()

_enableCrossEnvironment(): void

Internal

Called when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.

Returns

void

Inherited from

Resource._enableCrossEnvironment

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

Implementation of

INeptuneGraph.applyRemovalPolicy

Inherited from

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

Parameters

params?

NeptuneGraphNotebookProps

Returns

NeptuneGraphNotebook

Implementation of

INeptuneGraph.createNotebook

generatePhysicalName()

protected generatePhysicalName(): string

Returns

string

Inherited from

Resource.generatePhysicalName

getResourceArnAttribute()

protected getResourceArnAttribute(arnAttr, arnComponents): string

Returns an environment-sensitive token that should be used for the resource’s “ARN” attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arnAttr, but if the resource is referenced across environments, arnComponents will be used to synthesize a concrete ARN with the resource’s physical name. Make sure to reference this.physicalName in arnComponents.

Parameters

arnAttr

string

The CFN attribute which resolves to the ARN of the resource. Commonly it will be called “Arn” (e.g. resource.attrArn), but sometimes it’s the CFN resource’s ref.

arnComponents

ArnComponents

The format of the ARN of this resource. You must reference this.physicalName somewhere within the ARN in order for cross-environment references to work.

Returns

string

Inherited from

Resource.getResourceArnAttribute

getResourceNameAttribute()

protected getResourceNameAttribute(nameAttr): string

Returns an environment-sensitive token that should be used for the resource’s “name” attribute (e.g. bucket.bucketName).

Normally, this token will resolve to nameAttr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters

nameAttr

string

The CFN attribute which resolves to the resource’s name. Commonly this is the resource’s ref.

Returns

string

Inherited from

Resource.getResourceNameAttribute

grant()

grant(grantee, actions): Grant

Grant the given principal identity permissions to perform actions on this agent alias.

Parameters

grantee

IGrantable

actions

string[]

Returns

Grant

Implementation of

INeptuneGraph.grant

grantExportTask()

grantExportTask(grantee): Grant

Grant the given identity the permissions to export the graph into columnar structured .csv and .parquet files.

Parameters

grantee

IGrantable

Returns

Grant

Implementation of

INeptuneGraph.grantExportTask

grantFullAccess()

grantFullAccess(grantee): Grant

Grant the given identity full access to the Graph.

Parameters

grantee

IGrantable

Returns

Grant

Implementation of

INeptuneGraph.grantFullAccess

grantQuery()

grantQuery(grantee): Grant

Grant the given identity the permissions to query the Graph.

Parameters

grantee

IGrantable

Returns

Grant

Implementation of

INeptuneGraph.grantQuery

grantReadOnly()

grantReadOnly(grantee): Grant

Grant the given identity the permissions to read the Graph.

Parameters

grantee

IGrantable

Returns

Grant

Implementation of

INeptuneGraph.grantReadOnly

metric()

metric(metricName, props?): Metric

Return the given named metric for this graph.

By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the statistic and period properties.

Parameters

metricName

string

props?

MetricOptions

Returns

Metric

Implementation of

INeptuneGraph.metric

metricCPUUtilization()

metricCPUUtilization(props?): Metric

Returns metric for CPU utilization

Parameters

props?

MetricOptions

Returns

Metric

Implementation of

INeptuneGraph.metricCPUUtilization

metricGraphSizeBytes()

metricGraphSizeBytes(props?): Metric

Returns metric for graph size in bytes

Parameters

props?

MetricOptions

Returns

Metric

Implementation of

INeptuneGraph.metricGraphSizeBytes

metricGraphStorageUsagePercent()

metricGraphStorageUsagePercent(props?): Metric

Returns metric for graph storage usage percentage

Parameters

props?

MetricOptions

Returns

Metric

Implementation of

INeptuneGraph.metricGraphStorageUsagePercent

metricNumEdgeProperties()

metricNumEdgeProperties(props?): Metric

Returns metric for number of edge properties

Parameters

props?

MetricOptions

Returns

Metric

Implementation of

INeptuneGraph.metricNumEdgeProperties

metricNumEdges()

metricNumEdges(props?): Metric

Returns metric for number of edges

Parameters

props?

MetricOptions

Returns

Metric

Implementation of

INeptuneGraph.metricNumEdges

metricNumOpenCypherClientErrorsPerSec()

metricNumOpenCypherClientErrorsPerSec(props?): Metric

Returns metric for number of OpenCypher client errors per second

Parameters

props?

MetricOptions

Returns

Metric

Implementation of

INeptuneGraph.metricNumOpenCypherClientErrorsPerSec

metricNumOpenCypherRequestsPerSec()

metricNumOpenCypherRequestsPerSec(props?): Metric

Returns metric for number of OpenCypher requests per second

Parameters

props?

MetricOptions

Returns

Metric

Implementation of

INeptuneGraph.metricNumOpenCypherRequestsPerSec

metricNumOpenCypherServerErrorsPerSec()

metricNumOpenCypherServerErrorsPerSec(props?): Metric

Returns metric for number of OpenCypher server errors per second

Parameters

props?

MetricOptions

Returns

Metric

Implementation of

INeptuneGraph.metricNumOpenCypherServerErrorsPerSec

metricNumQueuedRequestsPerSec()

metricNumQueuedRequestsPerSec(props?): Metric

Returns metric for number of queued requests per second

Parameters

props?

MetricOptions

Returns

Metric

Implementation of

INeptuneGraph.metricNumQueuedRequestsPerSec

metricNumVectors()

metricNumVectors(props?): Metric

Returns metric for number of vectors

Parameters

props?

MetricOptions

Returns

Metric

Implementation of

INeptuneGraph.metricNumVectors

metricNumVertexProperties()

metricNumVertexProperties(props?): Metric

Returns metric for number of vertex properties

Parameters

props?

MetricOptions

Returns

Metric

Implementation of

INeptuneGraph.metricNumVertexProperties

toString()

toString(): string

Returns a string representation of this construct.

Returns

string

Inherited from

Resource.toString

isConstruct()

static isConstruct(x): x is Construct

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

x

any

Any object

Returns

x is Construct

true if x is an object created from a class which extends Construct.

Inherited from

Resource.isConstruct

isOwnedResource()

static isOwnedResource(construct): boolean

Returns true if the construct was created by CDK, and false otherwise

Parameters

construct

IConstruct

Returns

boolean

Inherited from

Resource.isOwnedResource

isResource()

static isResource(construct): construct is Resource

Check whether the given construct is a Resource

Parameters

construct

IConstruct

Returns

construct is Resource

Inherited from

Resource.isResource

This site is open source. Improve this page.