interface CfnGraphProps

Language	Type name
.NET	`Amazon.CDK.aws_neptunegraph.CfnGraphProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsneptunegraph#CfnGraphProps`
Java	`software.amazon.awscdk.services.neptunegraph.CfnGraphProps`
Python	`aws_cdk.aws_neptunegraph.CfnGraphProps`
TypeScript	`aws-cdk-lib` » `aws_neptunegraph` » `CfnGraphProps`

Properties for defining a CfnGraph.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_neptunegraph as neptunegraph } from 'aws-cdk-lib';
const cfnGraphProps: neptunegraph.CfnGraphProps = {
  provisionedMemory: 123,

  // the properties below are optional
  deletionProtection: false,
  graphName: 'graphName',
  publicConnectivity: false,
  replicaCount: 123,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vectorSearchConfiguration: {
    vectorSearchDimension: 123,
  },
};

Properties

Name	Type	Description
provisionedMemory	`number`	The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.
deletionProtection?	`boolean \|` `IResolvable`	A value that indicates whether the graph has deletion protection enabled.
graphName?	`string`	The graph name. For example: `my-graph-1` .
publicConnectivity?	`boolean \|` `IResolvable`	Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.
replicaCount?	`number`	The number of replicas in other AZs.
tags?	`CfnTag[]`	Adds metadata tags to the new graph.
vectorSearchConfiguration?	`IResolvable` `\|` `VectorSearchConfigurationProperty`	Specifies the number of dimensions for vector embeddings that will be loaded into the graph.

provisionedMemory

Type: number

The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.

Min = 128

deletionProtection?

Type: boolean | IResolvable (optional)

A value that indicates whether the graph has deletion protection enabled.

The graph can't be deleted when deletion protection is enabled.

graphName?

Type: string (optional)

The graph name. For example: my-graph-1 .

The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens.

If you don't specify a graph name, a unique graph name is generated for you using the prefix graph-for , followed by a combination of Stack Name and a UUID .

publicConnectivity?

Type: boolean | IResolvable (optional)

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.

When the graph is publicly available, its domain name system (DNS) endpoint resolves to the public IP address from the internet. When the graph isn't publicly available, you need to create a PrivateGraphEndpoint in a given VPC to ensure the DNS name resolves to a private IP address that is reachable from the VPC.

Default: If not specified, the default value is false.

If enabling public connectivity for the first time, there will be a delay while it is enabled.

replicaCount?

Type: number (optional)

The number of replicas in other AZs.

Default: If not specified, the default value is 1.

tags?

Type: CfnTag[] (optional)

Adds metadata tags to the new graph.

These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.

vectorSearchConfiguration?

Type: IResolvable | VectorSearchConfigurationProperty (optional)

Specifies the number of dimensions for vector embeddings that will be loaded into the graph.

The value is specified as dimension= value. Max = 65,535