interface NeptuneImportOptionsProperty

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

Options for importing data from a Neptune database.

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 neptuneImportOptionsProperty: neptunegraph.CfnGraph.NeptuneImportOptionsProperty = {
  s3ExportKmsKeyId: 's3ExportKmsKeyId',
  s3ExportPath: 's3ExportPath',

  // the properties below are optional
  preserveDefaultVertexLabels: false,
  preserveEdgeIds: false,
};

Properties

Name	Type	Description
s3ExportKmsKeyId	`string`	The KMS key to use to encrypt data in the S3 bucket where the graph data is exported.
s3ExportPath	`string`	The path to an S3 bucket from which to import data.
preserveDefaultVertexLabels?	`boolean \|` `IResolvable`	Neptune Analytics supports label-less vertices and no labels are assigned unless one is explicitly provided.
preserveEdgeIds?	`boolean \|` `IResolvable`	Neptune Analytics currently does not support user defined edge ids.

s3ExportKmsKeyId

Type: string

The KMS key to use to encrypt data in the S3 bucket where the graph data is exported.

s3ExportPath

Type: string

The path to an S3 bucket from which to import data.

preserveDefaultVertexLabels?

Type: boolean | IResolvable (optional)

Neptune Analytics supports label-less vertices and no labels are assigned unless one is explicitly provided.

Neptune assigns default labels when none is explicitly provided. When importing the data into Neptune Analytics, the default vertex labels can be omitted by setting preserveDefaultVertexLabels to false. Note that if the vertex only has default labels, and has no other properties or edges, then the vertex will effectively not get imported into Neptune Analytics when preserveDefaultVertexLabels is set to false.

preserveEdgeIds?

Type: boolean | IResolvable (optional)

Neptune Analytics currently does not support user defined edge ids.

The edge ids are not imported by default. They are imported if preserveEdgeIds is set to true, and ids are stored as properties on the relationships with the property name neptuneEdgeId.

AWS CDK

2.272.0