interface ImportTaskProperty

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

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptunegraph-graph-importtask.html

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

Name	Type	Description
roleArn	string	The ARN of the IAM role that will allow access to the data that is to be imported.
source	string	A URL identifying to the location of the data to be imported.
blankNodeHandling?	string	The method to handle blank nodes in the dataset.
failOnError?	boolean | IResolvable	If set to true, the task halts when an import error is encountered.
format?	string	Specifies the format of S3 data to be imported.
importOptions?	IResolvable | ImportOptionsProperty	Contains options for controlling the import process.
maxProvisionedMemory?	number	The maximum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.
minProvisionedMemory?	number	The minimum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.
parquetType?	string	The parquet type of the import task.

---

roleArn

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptunegraph-graph-importtask.html#cfn-neptunegraph-graph-importtask-rolearn

---

source

Type: string

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptunegraph-graph-importtask.html#cfn-neptunegraph-graph-importtask-source

---

blankNodeHandling?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptunegraph-graph-importtask.html#cfn-neptunegraph-graph-importtask-blanknodehandling

---

failOnError?

Type: boolean | IResolvable (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptunegraph-graph-importtask.html#cfn-neptunegraph-graph-importtask-failonerror

---

format?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptunegraph-graph-importtask.html#cfn-neptunegraph-graph-importtask-format

---

importOptions?

Type: IResolvable | ImportOptionsProperty (optional)

Contains options for controlling the import process.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptunegraph-graph-importtask.html#cfn-neptunegraph-graph-importtask-importoptions

---

maxProvisionedMemory?

Type: number (optional)

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

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptunegraph-graph-importtask.html#cfn-neptunegraph-graph-importtask-maxprovisionedmemory

---

minProvisionedMemory?

Type: number (optional)

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

Default: 16

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptunegraph-graph-importtask.html#cfn-neptunegraph-graph-importtask-minprovisionedmemory

---

parquetType?

Type: string (optional)

The parquet type of the import task.

Required when Format is PARQUET.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptunegraph-graph-importtask.html#cfn-neptunegraph-graph-importtask-parquettype