Skip to content

CreateGraphOutput

Source code in docs_src/capo_neptune_graph/types/create_graph_output.py
class CreateGraphOutput(TypedDict, closed=True):
    id: "capo_neptune_graph.types.graph_id.GraphId"
    """<p>The ID of the graph.</p>"""
    name: "capo_neptune_graph.types.graph_name.GraphName"
    """<p>The graph name. For example: <code>my-graph-1</code>.</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>"""
    arn: "str"
    """<p>The ARN of the graph.</p>"""
    status: NotRequired["capo_neptune_graph.types.graph_status.GraphStatus"]
    """<p>The current status of the graph.</p>"""
    status_reason: NotRequired["str"]
    """<p>The reason the status was given.</p>"""
    create_time: NotRequired["datetime.datetime"]
    """<p>The time when the graph was created.</p>"""
    provisioned_memory: NotRequired[
        "capo_neptune_graph.types.provisioned_memory.ProvisionedMemory"
    ]
    """<p>The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.</p> <p>Min = 16</p>"""
    endpoint: NotRequired["str"]
    """<p>The graph endpoint.</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.</p> <note> <p>If enabling public connectivity for the first time, there will be a delay while it is enabled.</p> </note>"""
    vector_search_configuration: NotRequired[
        "capo_neptune_graph.types.vector_search_configuration.VectorSearchConfiguration"
    ]
    """<p>The vector-search configuration for the graph, which specifies the vector dimension to use in the vector index, if any.</p>"""
    replica_count: NotRequired["capo_neptune_graph.types.replica_count.ReplicaCount"]
    """<p>The number of replicas in other AZs.</p> <p>Default: If not specified, the default value is 1.</p>"""
    kms_key_identifier: NotRequired["capo_neptune_graph.types.kms_key_arn.KmsKeyArn"]
    """<p>Specifies the KMS key used to encrypt data in the new graph.</p>"""
    source_snapshot_id: NotRequired["capo_neptune_graph.types.snapshot_id.SnapshotId"]
    """<p>The ID of the source graph.</p>"""
    deletion_protection: NotRequired["bool"]
    """<p>A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.</p>"""
    build_number: NotRequired["str"]
    """<p>The build number of the graph software.</p>"""

arn instance-attribute

arn: str

The ARN of the graph.

build_number instance-attribute

build_number: NotRequired[str]

The build number of the graph software.

create_time instance-attribute

create_time: NotRequired[datetime]

The time when the graph was created.

deletion_protection instance-attribute

deletion_protection: NotRequired[bool]

A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.

endpoint instance-attribute

endpoint: NotRequired[str]

The graph endpoint.

id instance-attribute

id: GraphId

The ID of the graph.

kms_key_identifier instance-attribute

kms_key_identifier: NotRequired[KmsKeyArn]

Specifies the KMS key used to encrypt data in the new graph.

name instance-attribute

name: GraphName

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

provisioned_memory instance-attribute

provisioned_memory: NotRequired[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.

If enabling public connectivity for the first time, there will be a delay while it is enabled.

replica_count instance-attribute

replica_count: NotRequired[ReplicaCount]

The number of replicas in other AZs.

Default: If not specified, the default value is 1.

source_snapshot_id instance-attribute

source_snapshot_id: NotRequired[SnapshotId]

The ID of the source graph.

status instance-attribute

status: NotRequired[GraphStatus]

The current status of the graph.

status_reason instance-attribute

status_reason: NotRequired[str]

The reason the status was given.

vector_search_configuration instance-attribute

vector_search_configuration: NotRequired[VectorSearchConfiguration]

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