Skip to content

CreateDBClusterEndpointOutput

Source code in docs_src/capo_neptune/types/create_db_cluster_endpoint_output.py
class CreateDBClusterEndpointOutput(TypedDict, closed=True):
    db_cluster_endpoint_identifier: NotRequired["capo_neptune.types.string.String"]
    """<p>The identifier associated with the endpoint. This parameter is stored as a lowercase string.</p>"""
    db_cluster_identifier: NotRequired["capo_neptune.types.string.String"]
    """<p>The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.</p>"""
    db_cluster_endpoint_resource_identifier: NotRequired[
        "capo_neptune.types.string.String"
    ]
    """<p>A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.</p>"""
    endpoint: NotRequired["capo_neptune.types.string.String"]
    """<p>The DNS address of the endpoint.</p>"""
    status: NotRequired["capo_neptune.types.string.String"]
    """<p>The current status of the endpoint. One of: <code>creating</code>, <code>available</code>, <code>deleting</code>, <code>inactive</code>, <code>modifying</code>. The <code>inactive</code> state applies to an endpoint that cannot be used for a certain kind of cluster, such as a <code>writer</code> endpoint for a read-only secondary cluster in a global database.</p>"""
    endpoint_type: NotRequired["capo_neptune.types.string.String"]
    """<p>The type of the endpoint. One of: <code>READER</code>, <code>WRITER</code>, <code>CUSTOM</code>.</p>"""
    custom_endpoint_type: NotRequired["capo_neptune.types.string.String"]
    """<p>The type associated with a custom endpoint. One of: <code>READER</code>, <code>WRITER</code>, <code>ANY</code>.</p>"""
    static_members: NotRequired["capo_neptune.types.string_list.StringList"]
    """<p>List of DB instance identifiers that are part of the custom endpoint group.</p>"""
    excluded_members: NotRequired["capo_neptune.types.string_list.StringList"]
    """<p>List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.</p>"""
    db_cluster_endpoint_arn: NotRequired["capo_neptune.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the endpoint.</p>"""

custom_endpoint_type instance-attribute

custom_endpoint_type: NotRequired[String]

The type associated with a custom endpoint. One of: READER, WRITER, ANY.

db_cluster_endpoint_arn instance-attribute

db_cluster_endpoint_arn: NotRequired[String]

The Amazon Resource Name (ARN) for the endpoint.

db_cluster_endpoint_identifier instance-attribute

db_cluster_endpoint_identifier: NotRequired[String]

The identifier associated with the endpoint. This parameter is stored as a lowercase string.

db_cluster_endpoint_resource_identifier instance-attribute

db_cluster_endpoint_resource_identifier: NotRequired[String]

A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

db_cluster_identifier instance-attribute

db_cluster_identifier: NotRequired[String]

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

endpoint instance-attribute

endpoint: NotRequired[String]

The DNS address of the endpoint.

endpoint_type instance-attribute

endpoint_type: NotRequired[String]

The type of the endpoint. One of: READER, WRITER, CUSTOM.

excluded_members instance-attribute

excluded_members: NotRequired[StringList]

List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

static_members instance-attribute

static_members: NotRequired[StringList]

List of DB instance identifiers that are part of the custom endpoint group.

status instance-attribute

status: NotRequired[String]

The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that cannot be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.