Skip to contents

Returns information about endpoints for an Amazon Aurora DB cluster

Source: R/rds_operations.R
rds_describe_db_cluster_endpoints.Rd

Returns information about endpoints for an Amazon Aurora DB cluster.

See https://www.paws-r-sdk.com/docs/rds_describe_db_cluster_endpoints/ for full documentation.

Usage

rds_describe_db_cluster_endpoints(
  DBClusterIdentifier = NULL,
  DBClusterEndpointIdentifier = NULL,
  Filters = NULL,
  MaxRecords = NULL,
  Marker = NULL
)

Arguments

DBClusterIdentifier

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

DBClusterEndpointIdentifier

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

Filters

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.

MaxRecords

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.

Marker

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