Returns information about endpoints for an Amazon Aurora DB cluster.
NoteThis action only applies to Aurora DB clusters.
Request ParametersFor information about the parameters that are common to all actions, see Common Parameters.
The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
Type: String
Required: No
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
Type: String
Required: No
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 Name=endpoint_type,Values=endpoint_type1,endpoint_type2,...
. Name
can be one of: db-cluster-endpoint-type
, db-cluster-endpoint-custom-type
, db-cluster-endpoint-id
, db-cluster-endpoint-status
. Values
for the db-cluster-endpoint-type
filter can be one or more of: reader
, writer
, custom
. Values
for the db-cluster-endpoint-custom-type
filter can be one or more of: reader
, any
. Values
for the db-cluster-endpoint-status
filter can be one or more of: available
, creating
, deleting
, inactive
, modifying
.
Type: Array of Filter objects
Required: No
An optional pagination token provided by a previous DescribeDBClusterEndpoints
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords
.
Type: String
Required: No
The maximum number of records to include in the response. If more records exist than the specified MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
Type: Integer
Required: No
The following elements are returned by the service.
Contains the details of the endpoints associated with the cluster and matching any filter conditions.
Type: Array of DBClusterEndpoint objects
An optional pagination token provided by a previous DescribeDBClusterEndpoints
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords
.
Type: String
For information about the errors that are common to all actions, see Common Errors.
DBClusterIdentifier
doesn't refer to an existing DB cluster.
HTTP Status Code: 404
For more information about using this API in one of the language-specific AWS SDKs, see the following:
DescribeDBClusterBacktracks
DescribeDBClusterParameterGroups
Did this page help you? - Yes
Thanks for letting us know we're doing a good job!
If you've got a moment, please tell us what we did right so we can do more of it.
Did this page help you? - No
Thanks for letting us know this page needs work. We're sorry we let you down.
If you've got a moment, please tell us how we can make the documentation better.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4