CfnGraphPropsMixin

class aws_cdk.mixins_preview.aws_neptunegraph.mixins.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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_neptunegraph import mixins as neptunegraph_mixins

cfn_graph_props_mixin = neptunegraph_mixins.CfnGraphPropsMixin(neptunegraph_mixins.CfnGraphMixinProps(
    deletion_protection=False,
    graph_name="graphName",
    provisioned_memory=123,
    public_connectivity=False,
    replica_count=123,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vector_search_configuration=neptunegraph_mixins.CfnGraphPropsMixin.VectorSearchConfigurationProperty(
        vector_search_dimension=123
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

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

Static Methods

classmethod is_mixin(x)

(experimental) 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.
Stability:: experimental

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.mixins_preview.aws_neptunegraph import mixins as neptunegraph_mixins

vector_search_configuration_property = neptunegraph_mixins.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