AWS::NeptuneGraph::Graph ImportTask - AWS CloudFormation
SyntaxProperties
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::NeptuneGraph::Graph ImportTask

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

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "BlankNodeHandling" : String,
  "FailOnError" : Boolean,
  "Format" : String,
  "ImportOptions" : ImportOptions,
  "MaxProvisionedMemory" : Integer,
  "MinProvisionedMemory" : Integer,
  "ParquetType" : String,
  "RoleArn" : String,
  "Source" : String
}

YAML

  BlankNodeHandling: String
  FailOnError: Boolean
  Format: String
  ImportOptions: 
    ImportOptions
  MaxProvisionedMemory: Integer
  MinProvisionedMemory: Integer
  ParquetType: String
  RoleArn: String
  Source: String

Properties

BlankNodeHandling

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. For more information, see Handling RDF values.

Required: No

Type: String

Allowed values: convertToIri

Update requires: Replacement

FailOnError

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.

Required: No

Type: Boolean

Update requires: Replacement

Format

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, PARQUET, which identifies the Apache Parquet format, or NTRIPLES, which identifies the RDF n-triples format.

Required: No

Type: String

Allowed values: CSV | OPEN_CYPHER | PARQUET | NTRIPLES

Update requires: Replacement

ImportOptions

Contains options for controlling the import process. Currently, only NeptuneImportOptions is available.

Required: No

Type: ImportOptions

Update requires: Replacement

MaxProvisionedMemory

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.

Required: No

Type: Integer

Minimum: 16

Maximum: 24576

Update requires: Replacement

MinProvisionedMemory

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

Required: No

Type: Integer

Minimum: 16

Maximum: 24576

Update requires: Replacement

ParquetType

The parquet type of the import task. Currently, only COLUMNAR is supported. Required when Format is PARQUET.

Required: No

Type: String

Allowed values: COLUMNAR

Update requires: Replacement

RoleArn

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

Required: Yes

Type: String

Pattern: arn:aws[^:]*:iam::[0-9]{12}:(role|role/service-role)(/[\w+=,.@-]+)+

Minimum: 1

Maximum: 1024

Update requires: Replacement

Source

A URL that identifies 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.

Required: Yes

Type: String

Update requires: Replacement