Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-142826341.7 MB

Returns information about endpoints for an Amazon Aurora DB cluster.

This action only applies to Aurora DB clusters.

get/#Action=DescribeDBClusterEndpoints

Query parameters

DBClusterIdentifierstring

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

DBClusterEndpointIdentifierstring

The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

Namestring required

The name of the filter. Filter names are case-sensitive.

Valuesstring[] required

One or more filter values. Filter values are case-sensitive.

A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format <code>Name=<i>endpoint_type</i>,Values=<i>endpoint_type1</i>,<i>endpoint_type2</i>,...</code>. <code>Name</code> can be one of: <code>db-cluster-endpoint-type</code>, <code>db-cluster-endpoint-custom-type</code>, <code>db-cluster-endpoint-id</code>, <code>db-cluster-endpoint-status</code>. <code>Values</code> for the <code> db-cluster-endpoint-type</code> filter can be one or more of: <code>reader</code>, <code>writer</code>, <code>custom</code>. <code>Values</code> for the <code>db-cluster-endpoint-custom-type</code> filter can be one or more of: <code>reader</code>, <code>any</code>. <code>Values</code> for the <code>db-cluster-endpoint-status</code> filter can be one or more of: <code>available</code>, <code>creating</code>, <code>deleting</code>, <code>inactive</code>, <code>modifying</code>.

MaxRecordsinteger
<p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so you can retrieve the remaining results.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>
Markerstring

An optional pagination token provided by a previous <code>DescribeDBClusterEndpoints</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.

Action'DescribeDBClusterEndpoints' required
Version'2014-10-31' required

Response

Success