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

Interface CfnGraphPropsMixin.NeptuneImportOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGraphPropsMixin.NeptuneImportOptionsProperty.Jsii$Proxy

Enclosing class:

CfnGraphPropsMixin

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

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 software.amazon.awscdk.cfnpropertymixins.services.neptunegraph.*;
 NeptuneImportOptionsProperty neptuneImportOptionsProperty = NeptuneImportOptionsProperty.builder()
         .preserveDefaultVertexLabels(false)
         .preserveEdgeIds(false)
         .s3ExportKmsKeyId("s3ExportKmsKeyId")
         .s3ExportPath("s3ExportPath")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnGraphPropsMixin.NeptuneImportOptionsProperty.Builder	builder()
default Object	getPreserveDefaultVertexLabels()	Neptune Analytics supports label-less vertices and no labels are assigned unless one is explicitly provided.
default Object	getPreserveEdgeIds()	Neptune Analytics currently does not support user defined edge ids.
default String	getS3ExportKmsKeyId()	The KMS key to use to encrypt data in the S3 bucket where the graph data is exported.
default String	getS3ExportPath()	The path to an S3 bucket from which to import data.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPreserveDefaultVertexLabels

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

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.

Returns union: either Boolean or IResolvable

See Also:

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

getPreserveEdgeIds

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

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.

Returns union: either Boolean or IResolvable

See Also:

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

getS3ExportKmsKeyId

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

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

See Also:

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

getS3ExportPath

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

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

See Also:

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

builder

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

Returns:

a CfnGraphPropsMixin.NeptuneImportOptionsProperty.Builder of CfnGraphPropsMixin.NeptuneImportOptionsProperty