Skip to content

GetClusterOutput

Source code in docs_src/capo_dsql/types/get_cluster_output.py
class GetClusterOutput(TypedDict, closed=True):
    identifier: "capo_dsql.types.cluster_id.ClusterId"
    """<p>The ID of the retrieved cluster.</p>"""
    arn: "capo_dsql.types.cluster_arn.ClusterArn"
    """<p>The ARN of the retrieved cluster.</p>"""
    status: "capo_dsql.types.cluster_status.ClusterStatus"
    """<p>The status of the retrieved cluster.</p>"""
    creation_time: "capo_dsql.types.cluster_creation_time.ClusterCreationTime"
    """<p>The time of when the cluster was created.</p>"""
    deletion_protection_enabled: (
        "capo_dsql.types.deletion_protection_enabled.DeletionProtectionEnabled"
    )
    """<p>Whether deletion protection is enabled in this cluster.</p>"""
    multi_region_properties: NotRequired[
        "capo_dsql.types.multi_region_properties.MultiRegionProperties"
    ]
    """<p>Returns the current multi-Region cluster configuration, including witness region and linked cluster information.</p>"""
    tags: NotRequired["capo_dsql.types.tag_map.TagMap"]
    encryption_details: NotRequired[
        "capo_dsql.types.encryption_details.EncryptionDetails"
    ]
    """<p>The current encryption configuration details for the cluster.</p>"""
    endpoint: NotRequired["capo_dsql.types.endpoint.Endpoint"]
    """<p>The connection endpoint for the cluster.</p>"""

arn instance-attribute

The ARN of the retrieved cluster.

creation_time instance-attribute

creation_time: ClusterCreationTime

The time of when the cluster was created.

deletion_protection_enabled instance-attribute

deletion_protection_enabled: DeletionProtectionEnabled

Whether deletion protection is enabled in this cluster.

encryption_details instance-attribute

encryption_details: NotRequired[EncryptionDetails]

The current encryption configuration details for the cluster.

endpoint instance-attribute

endpoint: NotRequired[Endpoint]

The connection endpoint for the cluster.

identifier instance-attribute

identifier: ClusterId

The ID of the retrieved cluster.

multi_region_properties instance-attribute

multi_region_properties: NotRequired[MultiRegionProperties]

Returns the current multi-Region cluster configuration, including witness region and linked cluster information.

status instance-attribute

status: ClusterStatus

The status of the retrieved cluster.

tags instance-attribute

tags: NotRequired[TagMap]