CfnGraph

class aws_cdk.aws_neptunegraph.CfnGraph(scope, id, *, provisioned_memory, deletion_protection=None, graph_name=None, import_task=None, kms_key_identifier=None, public_connectivity=None, replica_count=None, tags=None, vector_search_configuration=None)

Bases: CfnResource

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
ExampleMetadata:: fixture=_generated

Example:

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

cfn_graph = neptunegraph.CfnGraph(self, "MyCfnGraph",
    provisioned_memory=123,

    # the properties below are optional
    deletion_protection=False,
    graph_name="graphName",
    import_task=neptunegraph.CfnGraph.ImportTaskProperty(
        role_arn="roleArn",
        source="source",

        # the properties below are optional
        blank_node_handling="blankNodeHandling",
        fail_on_error=False,
        format="format",
        import_options=neptunegraph.CfnGraph.ImportOptionsProperty(
            neptune=neptunegraph.CfnGraph.NeptuneImportOptionsProperty(
                s3_export_kms_key_id="s3ExportKmsKeyId",
                s3_export_path="s3ExportPath",

                # the properties below are optional
                preserve_default_vertex_labels=False,
                preserve_edge_ids=False
            )
        ),
        max_provisioned_memory=123,
        min_provisioned_memory=123,
        parquet_type="parquetType"
    ),
    kms_key_identifier="kmsKeyIdentifier",
    public_connectivity=False,
    replica_count=123,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vector_search_configuration=neptunegraph.CfnGraph.VectorSearchConfigurationProperty(
        vector_search_dimension=123
    )
)

Create a new AWS::NeptuneGraph::Graph.

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
provisioned_memory (Union[int, float]) – The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 16
deletion_protection (Union[bool, IResolvable, None]) – A value that indicates whether the graph has deletion protection enabled. The graph can’t be deleted when deletion protection is enabled.
graph_name (Optional[str]) – The graph name. For example: my-graph-1 . The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens. If you don’t specify a graph name, a unique graph name is generated for you using the prefix graph-for , followed by a combination of Stack Name and a UUID .
import_task (Union[IResolvable, ImportTaskProperty, Dict[str, Any], None]) – The import task details to import data into the graph at creation time.
kms_key_identifier (Optional[str]) – The ARN of the KMS key used to encrypt data in the Neptune Analytics graph. If not specified, the graph is encrypted with an AWS managed key.
public_connectivity (Union[bool, IResolvable, None]) – Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. When the graph is publicly available, its domain name system (DNS) endpoint resolves to the public IP address from the internet. When the graph isn’t publicly available, you need to create a PrivateGraphEndpoint in a given VPC to ensure the DNS name resolves to a private IP address that is reachable from the VPC. Default: If not specified, the default value is false. .. epigraph:: If enabling public connectivity for the first time, there will be a delay while it is enabled.
replica_count (Union[int, float, None]) – The number of replicas in other AZs. Default: If not specified, the default value is 1.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.
vector_search_configuration (Union[IResolvable, VectorSearchConfigurationProperty, Dict[str, Any], None]) – Specifies the number of dimensions for vector embeddings that will be loaded into the graph. The value is specified as dimension= value. Max = 65,535

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

Parameters:: target (CfnResource)
Deprecated:: Use addResourceDependency instead.
Stability:: deprecated
Return type:: None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

Parameters:: target (CfnResource)
Deprecated:: Use addResourceDependency instead.
Stability:: deprecated
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

add_resource_dependency(target, reason=None)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

Parameters:

target (CfnResource)
reason (Optional[str])

Return type:

None

apply_cross_stack_reference_strength(strength)

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack’s context.

Parameters:

strength (ReferenceStrength) –

The reference strength to use for this resource.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

cfn_property_name(cdk_property_name)

Parameters:: cdk_property_name (str)
Return type:: Optional[str]

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

Return type:: List[Union[Stack, CfnResource]]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

(deprecated) Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Deprecated:: Use removeResourceDependency instead
Stability:: deprecated
Return type:: None

remove_resource_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

with_(*mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:: mixins (IMixin)
Return type:: IConstruct

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::NeptuneGraph::Graph'

attr_endpoint

The connection endpoint for the graph.

For example: g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com

CloudformationAttribute:: Endpoint

attr_graph_arn

The ARN of the graph.

For example: arn:aws:neptune-graph:us-east-1:111122223333:graph/g-12a3bcdef4

CloudformationAttribute:: GraphArn

attr_graph_id

The ID of the graph.

For example: g-12a3bcdef4

CloudformationAttribute:: GraphId

cdk_tag_manager: Tag Manager which manages the tags for this resource.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

deletion_protection: A value that indicates whether the graph has deletion protection enabled.

env

graph_name

The graph name.

For example: my-graph-1 .

graph_ref: A reference to a Graph resource.

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

kms_key_identifier: The ARN of the KMS key used to encrypt data in the Neptune Analytics graph.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The tree node.

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

public_connectivity

Specifies whether or not the graph can be reachable over the internet.

All access to graphs is IAM authenticated.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

replica_count: The number of replicas in other AZs.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: Adds metadata tags to the new graph.

vector_search_configuration: Specifies the number of dimensions for vector embeddings that will be loaded into the graph.

Static Methods

classmethod arn_for_graph(resource)

Parameters:: resource (IGraphRef)
Return type:: str

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:: x (Any)
Return type:: bool
Returns:: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_graph(x)

Checks whether the given object is a CfnGraph.

Parameters:: x (Any)
Return type:: bool

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:: x (Any)
Return type:: bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

ImportOptionsProperty

class CfnGraph.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 import aws_neptunegraph as neptunegraph

import_options_property = neptunegraph.CfnGraph.ImportOptionsProperty(
    neptune=neptunegraph.CfnGraph.NeptuneImportOptionsProperty(
        s3_export_kms_key_id="s3ExportKmsKeyId",
        s3_export_path="s3ExportPath",

        # the properties below are optional
        preserve_default_vertex_labels=False,
        preserve_edge_ids=False
    )
)

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 CfnGraph.ImportTaskProperty(*, role_arn, source, blank_node_handling=None, fail_on_error=None, format=None, import_options=None, max_provisioned_memory=None, min_provisioned_memory=None, parquet_type=None)

Bases: object

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

Parameters:

role_arn (str) – The ARN of the IAM role that will allow access to the data that is to be imported.
source (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.
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.

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 import aws_neptunegraph as neptunegraph

import_task_property = neptunegraph.CfnGraph.ImportTaskProperty(
    role_arn="roleArn",
    source="source",

    # the properties below are optional
    blank_node_handling="blankNodeHandling",
    fail_on_error=False,
    format="format",
    import_options=neptunegraph.CfnGraph.ImportOptionsProperty(
        neptune=neptunegraph.CfnGraph.NeptuneImportOptionsProperty(
            s3_export_kms_key_id="s3ExportKmsKeyId",
            s3_export_path="s3ExportPath",

            # the properties below are optional
            preserve_default_vertex_labels=False,
            preserve_edge_ids=False
        )
    ),
    max_provisioned_memory=123,
    min_provisioned_memory=123,
    parquet_type="parquetType"
)

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 CfnGraph.NeptuneImportOptionsProperty(*, s3_export_kms_key_id, s3_export_path, preserve_default_vertex_labels=None, preserve_edge_ids=None)

Bases: object

Options for importing data from a Neptune database.

Parameters:

s3_export_kms_key_id (str) – The KMS key to use to encrypt data in the S3 bucket where the graph data is exported.
s3_export_path (str) – The path to an S3 bucket from which to import data.
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.

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 import aws_neptunegraph as neptunegraph

neptune_import_options_property = neptunegraph.CfnGraph.NeptuneImportOptionsProperty(
    s3_export_kms_key_id="s3ExportKmsKeyId",
    s3_export_path="s3ExportPath",

    # the properties below are optional
    preserve_default_vertex_labels=False,
    preserve_edge_ids=False
)

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 CfnGraph.VectorSearchConfigurationProperty(*, vector_search_dimension)

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]) – 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 import aws_neptunegraph as neptunegraph

vector_search_configuration_property = neptunegraph.CfnGraph.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