Skip to content

GraphSummary

Source code in docs_src/capo_neptune_graph/types/graph_summary.py
class GraphSummary(TypedDict, closed=True):
    id: "capo_neptune_graph.types.graph_id.GraphId"
    """<p>The unique identifier of the graph.</p>"""
    name: "capo_neptune_graph.types.graph_name.GraphName"
    """<p>The name of the graph.</p>"""
    arn: "str"
    """<p>The ARN associated with the graph.</p>"""
    status: NotRequired["capo_neptune_graph.types.graph_status.GraphStatus"]
    """<p>The status of the graph.</p>"""
    provisioned_memory: NotRequired[
        "capo_neptune_graph.types.provisioned_memory.ProvisionedMemory"
    ]
    """<p>The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.</p>"""
    public_connectivity: NotRequired["bool"]
    """<p>If <code>true</code>, the graph has a public endpoint, otherwise not.</p>"""
    endpoint: NotRequired["str"]
    """<p>The graph endpoint.</p>"""
    replica_count: NotRequired["capo_neptune_graph.types.replica_count.ReplicaCount"]
    """<p>The number of replicas for the graph.</p>"""
    kms_key_identifier: NotRequired["str"]
    """<p>The ID of the KMS key used to encrypt and decrypt graph data.</p>"""
    deletion_protection: NotRequired["bool"]
    """<p>If <code>true</code>, deletion protection is enabled for the graph.</p>"""

arn instance-attribute

arn: str

The ARN associated with the graph.

deletion_protection instance-attribute

deletion_protection: NotRequired[bool]

If true, deletion protection is enabled for the graph.

endpoint instance-attribute

endpoint: NotRequired[str]

The graph endpoint.

id instance-attribute

id: GraphId

The unique identifier of the graph.

kms_key_identifier instance-attribute

kms_key_identifier: NotRequired[str]

The ID of the KMS key used to encrypt and decrypt graph data.

name instance-attribute

name: GraphName

The name of the graph.

provisioned_memory instance-attribute

provisioned_memory: NotRequired[ProvisionedMemory]

The number of memory-optimized Neptune Capacity Units (m-NCUs) allocated to the graph.

public_connectivity instance-attribute

public_connectivity: NotRequired[bool]

If true, the graph has a public endpoint, otherwise not.

replica_count instance-attribute

replica_count: NotRequired[ReplicaCount]

The number of replicas for the graph.

status instance-attribute

status: NotRequired[GraphStatus]

The status of the graph.