Package software.amazon.awscdk.cfnpropertymixins.services.neptunegraph

Interface CfnGraphPropsMixin.ImportTaskProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGraphPropsMixin.ImportTaskProperty.Jsii$Proxy

Enclosing class:

CfnGraphPropsMixin

@Stability(Stable)
public static interface CfnGraphPropsMixin.ImportTaskProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.neptunegraph.*;
 ImportTaskProperty importTaskProperty = ImportTaskProperty.builder()
         .blankNodeHandling("blankNodeHandling")
         .failOnError(false)
         .format("format")
         .importOptions(ImportOptionsProperty.builder()
                 .neptune(NeptuneImportOptionsProperty.builder()
                         .preserveDefaultVertexLabels(false)
                         .preserveEdgeIds(false)
                         .s3ExportKmsKeyId("s3ExportKmsKeyId")
                         .s3ExportPath("s3ExportPath")
                         .build())
                 .build())
         .maxProvisionedMemory(123)
         .minProvisionedMemory(123)
         .parquetType("parquetType")
         .roleArn("roleArn")
         .source("source")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGraphPropsMixin.ImportTaskProperty.Builder	A builder for CfnGraphPropsMixin.ImportTaskProperty
static final class	CfnGraphPropsMixin.ImportTaskProperty.Jsii$Proxy	An implementation for CfnGraphPropsMixin.ImportTaskProperty

Method Summary

Modifier and Type	Method	Description
static CfnGraphPropsMixin.ImportTaskProperty.Builder	builder()
default String	getBlankNodeHandling()	The method to handle blank nodes in the dataset.
default Object	getFailOnError()	If set to true, the task halts when an import error is encountered.
default String	getFormat()	Specifies the format of S3 data to be imported.
default Object	getImportOptions()	Contains options for controlling the import process.
default Number	getMaxProvisionedMemory()	The maximum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.
default Number	getMinProvisionedMemory()	The minimum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.
default String	getParquetType()	The parquet type of the import task.
default String	getRoleArn()	The ARN of the IAM role that will allow access to the data that is to be imported.
default String	getSource()	A URL identifying to the location of the data to be imported.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBlankNodeHandling

@Stability(Stable)
@Nullable
default String getBlankNodeHandling()

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

getFailOnError

@Stability(Stable)
@Nullable
default Object getFailOnError()

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.

Returns union: either Boolean or IResolvable

See Also:

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

getFormat

@Stability(Stable)
@Nullable
default String getFormat()

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

getImportOptions

@Stability(Stable)
@Nullable
default Object getImportOptions()

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

Returns union: either IResolvable or CfnGraphPropsMixin.ImportOptionsProperty

See Also:

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

getMaxProvisionedMemory

@Stability(Stable)
@Nullable
default Number getMaxProvisionedMemory()

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

getMinProvisionedMemory

@Stability(Stable)
@Nullable
default Number getMinProvisionedMemory()

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

getParquetType

@Stability(Stable)
@Nullable
default String getParquetType()

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

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

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

getSource

@Stability(Stable)
@Nullable
default String getSource()

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

builder

@Stability(Stable)
static CfnGraphPropsMixin.ImportTaskProperty.Builder builder()

Returns:

a CfnGraphPropsMixin.ImportTaskProperty.Builder of CfnGraphPropsMixin.ImportTaskProperty