aws-cdk-lib.aws_neptunegraph.CfnGraph.ImportTaskProperty

ImportTaskProperty Struct

The import task details to import data into the graph at creation time.

Source

Generated code

Type last changed

v2.272.0 · 30 Sep 2026

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 importTaskProperty: neptunegraph.CfnGraph.ImportTaskProperty = {
  roleArn: 'roleArn',
  source: 'source',

  // the properties below are optional
  blankNodeHandling: 'blankNodeHandling',
  failOnError: false,
  format: 'format',
  importOptions: {
    neptune: {
      s3ExportKmsKeyId: 's3ExportKmsKeyId',
      s3ExportPath: 's3ExportPath',

      // the properties below are optional
      preserveDefaultVertexLabels: false,
      preserveEdgeIds: false,
    },
  },
  maxProvisionedMemory: 123,
  minProvisionedMemory: 123,
  parquetType: 'parquetType',
};

Properties

blankNodeHandling?optionalstringblank_node_handling?optionalstrblankNodeHandling?optionalStringBlankNodeHandling?optionalstringBlankNodeHandling?optional*string#

The method to handle blank nodes in the dataset.

Currently, only convertToIri is supported, meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is NTRIPLES

failOnError?optionalboolean | IResolvablefail_on_error?optionaltyping.Union[bool, IResolvable]failOnError?optionalBooleanFailOnError?optionalboolFailOnError?optionalinterface{}#

If set to true, the task halts when an import error is encountered.

If set to false, the task skips the data that caused the error and continues if possible.

format?optionalstringformat?optionalstrformat?optionalStringFormat?optionalstringFormat?optional*string#

Specifies the format of S3 data to be imported.

Valid values are CSV, which identifies the Gremlin CSV format, OPEN_CYPHER, which identifies the openCypher load format, or NTRIPLES, which identifies the RDF n-triples format.

importOptions?optionalIResolvable | CfnGraph.ImportOptionsPropertyimport_options?optionaltyping.Union[IResolvable, ImportOptionsProperty]importOptions?optionalIResolvableImportOptions?optionalIResolvableImportOptions?optionalinterface{}#

Contains options for controlling the import process.

notes

For example, if the failOnError key is set to false, the import skips the data that caused the error and continues if possible (whereas if set to true, the default, or if omitted, the import operation halts immediately when an error is encountered).

maxProvisionedMemory?optionalnumbermax_provisioned_memory?optionalint | floatmaxProvisionedMemory?optionalNumberMaxProvisionedMemory?optionaldoubleMaxProvisionedMemory?optional*float64#

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

notes

Default: 1024, or the approved upper limit for your account. If both the minimum and maximum values are specified, the final provisioned-memory will be chosen per the actual size of your imported data. If neither value is specified, 128 m-NCUs are used.

minProvisionedMemory?optionalnumbermin_provisioned_memory?optionalint | floatminProvisionedMemory?optionalNumberMinProvisionedMemory?optionaldoubleMinProvisionedMemory?optional*float64#

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

Default: 16

parquetType?optionalstringparquet_type?optionalstrparquetType?optionalStringParquetType?optionalstringParquetType?optional*string#

The parquet type of the import task.

Required when Format is PARQUET.

roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*stringrequired#

The ARN of the IAM role that will allow access to the data that is to be imported.

sourcestringsourcestrsourceStringSourcestringSource*stringrequired#

A URL identifying to the location of the data to be imported.

This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.