Skip to content

RDS  >  Structures  >  DBClusterEndpoint

DBClusterEndpoint

Structure Class

DBClusterEndpoint dataclass

Bases: _SerdeShape

This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:

  • CreateDBClusterEndpoint

  • DescribeDBClusterEndpoints

  • ModifyDBClusterEndpoint

  • DeleteDBClusterEndpoint

For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.

Attributes

custom_endpoint_type class-attribute instance-attribute
custom_endpoint_type: str | None = ...

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

db_cluster_endpoint_arn class-attribute instance-attribute
db_cluster_endpoint_arn: str | None = ...

The Amazon Resource Name (ARN) for the endpoint.

db_cluster_endpoint_identifier class-attribute instance-attribute
db_cluster_endpoint_identifier: str | None = ...

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

db_cluster_endpoint_resource_identifier class-attribute instance-attribute
db_cluster_endpoint_resource_identifier: str | None = ...

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

db_cluster_identifier class-attribute instance-attribute
db_cluster_identifier: str | None = ...

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

endpoint class-attribute instance-attribute
endpoint: str | None = ...

The DNS address of the endpoint.

endpoint_type class-attribute instance-attribute
endpoint_type: str | None = ...

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

excluded_members class-attribute instance-attribute
excluded_members: list[str] | None = ...

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 class-attribute instance-attribute
static_members: list[str] | None = ...

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

status class-attribute instance-attribute
status: str | None = ...

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