CfnGraphPropsMixin

class aws_cdk.cfn_property_mixins.aws_neptunegraph.CfnGraphPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS ::NeptuneGraph::Graph resource creates an graph.

is a memory-optimized graph database engine for analytics. For more information, see ` <https://docs.aws.amazon.com/neptune-analytics/latest/userguide/what-is-neptune-analytics.html>`_ .

You can use AWS ::NeptuneGraph::Graph.DeletionProtection to help guard against unintended deletion of your graph.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptunegraph-graph.html
CloudformationResource:: AWS::NeptuneGraph::Graph
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_neptunegraph as neptunegraph
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_graph_props_mixin = neptunegraph.CfnGraphPropsMixin(neptunegraph.CfnGraphMixinProps(
    deletion_protection=False,
    graph_name="graphName",
    import_task=neptunegraph.CfnGraphPropsMixin.ImportTaskProperty(
        blank_node_handling="blankNodeHandling",
        fail_on_error=False,
        format="format",
        import_options=neptunegraph.CfnGraphPropsMixin.ImportOptionsProperty(
            neptune=neptunegraph.CfnGraphPropsMixin.NeptuneImportOptionsProperty(
                preserve_default_vertex_labels=False,
                preserve_edge_ids=False,
                s3_export_kms_key_id="s3ExportKmsKeyId",
                s3_export_path="s3ExportPath"
            )
        ),
        max_provisioned_memory=123,
        min_provisioned_memory=123,
        parquet_type="parquetType",
        role_arn="roleArn",
        source="source"
    ),
    kms_key_identifier="kmsKeyIdentifier",
    provisioned_memory=123,
    public_connectivity=False,
    replica_count=123,
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    vector_search_configuration=neptunegraph.CfnGraphPropsMixin.VectorSearchConfigurationProperty(
        vector_search_dimension=123
    )
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::NeptuneGraph::Graph.

Parameters:

props (Union[CfnGraphMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['deletionProtection', 'graphName', 'importTask', 'kmsKeyIdentifier', 'provisionedMemory', 'publicConnectivity', 'replicaCount', 'tags', 'vectorSearchConfiguration']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

ImportOptionsProperty

class CfnGraphPropsMixin.ImportOptionsProperty(*, neptune=None)

Bases: object

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

Parameters:: neptune (Union[IResolvable, NeptuneImportOptionsProperty, Dict[str, Any], None]) – Options for importing data from a Neptune database.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptunegraph-graph-importoptions.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_neptunegraph as neptunegraph

import_options_property = neptunegraph.CfnGraphPropsMixin.ImportOptionsProperty(
    neptune=neptunegraph.CfnGraphPropsMixin.NeptuneImportOptionsProperty(
        preserve_default_vertex_labels=False,
        preserve_edge_ids=False,
        s3_export_kms_key_id="s3ExportKmsKeyId",
        s3_export_path="s3ExportPath"
    )
)

Attributes

neptune

Options for importing data from a Neptune database.

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

ImportTaskProperty

class CfnGraphPropsMixin.ImportTaskProperty(*, blank_node_handling=None, fail_on_error=None, format=None, import_options=None, max_provisioned_memory=None, min_provisioned_memory=None, parquet_type=None, role_arn=None, source=None)

Bases: object

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

Parameters:

blank_node_handling (Optional[str]) – 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
fail_on_error (Union[bool, IResolvable, None]) – 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 (Optional[str]) – 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.
import_options (Union[IResolvable, ImportOptionsProperty, Dict[str, Any], None]) – 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).
max_provisioned_memory (Union[int, float, None]) – 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.
min_provisioned_memory (Union[int, float, None]) – The minimum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 16
parquet_type (Optional[str]) – The parquet type of the import task. Required when Format is PARQUET.
role_arn (Optional[str]) – The ARN of the IAM role that will allow access to the data that is to be imported.
source (Optional[str]) – 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:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_neptunegraph as neptunegraph

import_task_property = neptunegraph.CfnGraphPropsMixin.ImportTaskProperty(
    blank_node_handling="blankNodeHandling",
    fail_on_error=False,
    format="format",
    import_options=neptunegraph.CfnGraphPropsMixin.ImportOptionsProperty(
        neptune=neptunegraph.CfnGraphPropsMixin.NeptuneImportOptionsProperty(
            preserve_default_vertex_labels=False,
            preserve_edge_ids=False,
            s3_export_kms_key_id="s3ExportKmsKeyId",
            s3_export_path="s3ExportPath"
        )
    ),
    max_provisioned_memory=123,
    min_provisioned_memory=123,
    parquet_type="parquetType",
    role_arn="roleArn",
    source="source"
)

Attributes

blank_node_handling

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptunegraph-graph-importtask.html#cfn-neptunegraph-graph-importtask-blanknodehandling

fail_on_error

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptunegraph-graph-importtask.html#cfn-neptunegraph-graph-importtask-failonerror

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

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

import_options

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptunegraph-graph-importtask.html#cfn-neptunegraph-graph-importtask-importoptions

max_provisioned_memory

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptunegraph-graph-importtask.html#cfn-neptunegraph-graph-importtask-maxprovisionedmemory

min_provisioned_memory

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

Default: 16

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

parquet_type

The parquet type of the import task.

Required when Format is PARQUET.

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

role_arn

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

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

source

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptunegraph-graph-importtask.html#cfn-neptunegraph-graph-importtask-source

NeptuneImportOptionsProperty

class CfnGraphPropsMixin.NeptuneImportOptionsProperty(*, preserve_default_vertex_labels=None, preserve_edge_ids=None, s3_export_kms_key_id=None, s3_export_path=None)

Bases: object

Options for importing data from a Neptune database.

Parameters:

preserve_default_vertex_labels (Union[bool, IResolvable, None]) – 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.
preserve_edge_ids (Union[bool, IResolvable, None]) – 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.
s3_export_kms_key_id (Optional[str]) – The KMS key to use to encrypt data in the S3 bucket where the graph data is exported.
s3_export_path (Optional[str]) – The path to an S3 bucket from which to import data.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_neptunegraph as neptunegraph

neptune_import_options_property = neptunegraph.CfnGraphPropsMixin.NeptuneImportOptionsProperty(
    preserve_default_vertex_labels=False,
    preserve_edge_ids=False,
    s3_export_kms_key_id="s3ExportKmsKeyId",
    s3_export_path="s3ExportPath"
)

Attributes

preserve_default_vertex_labels

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.

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

preserve_edge_ids

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.

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

s3_export_kms_key_id

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

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

s3_export_path

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

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

VectorSearchConfigurationProperty

class CfnGraphPropsMixin.VectorSearchConfigurationProperty(*, vector_search_dimension=None)

Bases: object

The vector-search configuration for the graph, which specifies the vector dimension to use in the vector index, if any.

Parameters:: vector_search_dimension (Union[int, float, None]) – The number of dimensions.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptunegraph-graph-vectorsearchconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_neptunegraph as neptunegraph

vector_search_configuration_property = neptunegraph.CfnGraphPropsMixin.VectorSearchConfigurationProperty(
    vector_search_dimension=123
)

Attributes

vector_search_dimension

The number of dimensions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-neptunegraph-graph-vectorsearchconfiguration.html#cfn-neptunegraph-graph-vectorsearchconfiguration-vectorsearchdimension