Skip to content

CreateGraphInput

Source code in docs_src/capo_neptune_graph/types/create_graph_input.py
class CreateGraphInput(TypedDict, closed=True):
    graph_name: "capo_neptune_graph.types.graph_name.GraphName"
    """<p>A name for the new Neptune Analytics graph to be created.</p> <p>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. Only lowercase letters are allowed.</p>"""
    tags: NotRequired["capo_neptune_graph.types.tag_map.TagMap"]
    """<p>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.</p>"""
    public_connectivity: NotRequired["bool"]
    """<p>Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (<code>true</code> to enable, or <code>false</code> to disable.</p>"""
    kms_key_identifier: NotRequired["capo_neptune_graph.types.kms_key_arn.KmsKeyArn"]
    """<p>Specifies a KMS key to use to encrypt data in the new graph.</p>"""
    vector_search_configuration: NotRequired[
        "capo_neptune_graph.types.vector_search_configuration.VectorSearchConfiguration"
    ]
    """<p>Specifies the number of dimensions for vector embeddings that will be loaded into the graph. The value is specified as <code>dimension=</code>value. Max = 65,535</p>"""
    replica_count: NotRequired["capo_neptune_graph.types.replica_count.ReplicaCount"]
    """<p>The number of replicas in other AZs. Min =0, Max = 2, Default = 1.</p> <important> <p> Additional charges equivalent to the m-NCUs selected for the graph apply for each replica. </p> </important>"""
    deletion_protection: NotRequired["bool"]
    """<p>Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled. (<code>true</code> or <code>false</code>).</p>"""
    provisioned_memory: "capo_neptune_graph.types.provisioned_memory.ProvisionedMemory"
    """<p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 16</p>"""

deletion_protection instance-attribute

deletion_protection: NotRequired[bool]

Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled. (true or false).

graph_name instance-attribute

graph_name: GraphName

A name for the new Neptune Analytics graph to be created.

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. Only lowercase letters are allowed.

kms_key_identifier instance-attribute

kms_key_identifier: NotRequired[KmsKeyArn]

Specifies a KMS key to use to encrypt data in the new graph.

provisioned_memory instance-attribute

provisioned_memory: ProvisionedMemory

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

public_connectivity instance-attribute

public_connectivity: NotRequired[bool]

Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (true to enable, or false to disable.

replica_count instance-attribute

replica_count: NotRequired[ReplicaCount]

The number of replicas in other AZs. Min =0, Max = 2, Default = 1.

Additional charges equivalent to the m-NCUs selected for the graph apply for each replica.

tags instance-attribute

tags: NotRequired[TagMap]

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 instance-attribute

vector_search_configuration: NotRequired[VectorSearchConfiguration]

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