Amazonka.Neptune.DescribeDBClusterEndpoints

Returns information about endpoints for an Amazon Neptune DB cluster.

This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.

This operation returns paginated results.

Creating a Request

data DescribeDBClusterEndpoints

See: newDescribeDBClusterEndpoints smart constructor.

Constructors

DescribeDBClusterEndpoints'

Fields

• dbClusterEndpointIdentifier :: Maybe Text

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

• dbClusterIdentifier :: Maybe Text

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

• filters :: Maybe [Filter]

  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.

• marker :: Maybe Text

  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.

• maxRecords :: Maybe Int

  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.

Instances

ToHeaders DescribeDBClusterEndpoints

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Methods

toHeaders :: DescribeDBClusterEndpoints -> [Header]

ToPath DescribeDBClusterEndpoints

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Methods

toPath :: DescribeDBClusterEndpoints -> ByteString

ToQuery DescribeDBClusterEndpoints

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Methods

toQuery :: DescribeDBClusterEndpoints -> QueryString

AWSPager DescribeDBClusterEndpoints

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Methods

page :: DescribeDBClusterEndpoints -> AWSResponse DescribeDBClusterEndpoints -> Maybe DescribeDBClusterEndpoints

AWSRequest DescribeDBClusterEndpoints

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Associated Types

type AWSResponse DescribeDBClusterEndpoints

Methods

request :: (Service -> Service) -> DescribeDBClusterEndpoints -> Request DescribeDBClusterEndpoints

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDBClusterEndpoints -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDBClusterEndpoints)))

Generic DescribeDBClusterEndpoints

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Associated Types

type Rep DescribeDBClusterEndpoints :: Type -> Type

Methods

from :: DescribeDBClusterEndpoints -> Rep DescribeDBClusterEndpoints x

to :: Rep DescribeDBClusterEndpoints x -> DescribeDBClusterEndpoints

Read DescribeDBClusterEndpoints

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Methods

readsPrec :: Int -> ReadS DescribeDBClusterEndpoints

readList :: ReadS [DescribeDBClusterEndpoints]

readPrec :: ReadPrec DescribeDBClusterEndpoints

readListPrec :: ReadPrec [DescribeDBClusterEndpoints]

Show DescribeDBClusterEndpoints

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Methods

showsPrec :: Int -> DescribeDBClusterEndpoints -> ShowS

show :: DescribeDBClusterEndpoints -> String

showList :: [DescribeDBClusterEndpoints] -> ShowS

NFData DescribeDBClusterEndpoints

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Methods

rnf :: DescribeDBClusterEndpoints -> ()

Eq DescribeDBClusterEndpoints

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Methods

(==) :: DescribeDBClusterEndpoints -> DescribeDBClusterEndpoints -> Bool

(/=) :: DescribeDBClusterEndpoints -> DescribeDBClusterEndpoints -> Bool

Hashable DescribeDBClusterEndpoints

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Methods

hashWithSalt :: Int -> DescribeDBClusterEndpoints -> Int

hash :: DescribeDBClusterEndpoints -> Int

type AWSResponse DescribeDBClusterEndpoints

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

type AWSResponse DescribeDBClusterEndpoints = DescribeDBClusterEndpointsResponse

type Rep DescribeDBClusterEndpoints

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

type Rep DescribeDBClusterEndpoints = D1 ('MetaData "DescribeDBClusterEndpoints" "Amazonka.Neptune.DescribeDBClusterEndpoints" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" 'False) (C1 ('MetaCons "DescribeDBClusterEndpoints'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbClusterEndpointIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))

newDescribeDBClusterEndpoints :: DescribeDBClusterEndpoints

Create a value of DescribeDBClusterEndpoints with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

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

$sel:filters:DescribeDBClusterEndpoints', describeDBClusterEndpoints_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.

DescribeDBClusterEndpoints, describeDBClusterEndpoints_marker - 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.

$sel:maxRecords:DescribeDBClusterEndpoints', describeDBClusterEndpoints_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.

Request Lenses

describeDBClusterEndpoints_dbClusterEndpointIdentifier :: Lens' DescribeDBClusterEndpoints (Maybe Text)

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

describeDBClusterEndpoints_dbClusterIdentifier :: Lens' DescribeDBClusterEndpoints (Maybe Text)

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

describeDBClusterEndpoints_filters :: Lens' DescribeDBClusterEndpoints (Maybe [Filter])

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.

describeDBClusterEndpoints_marker :: Lens' DescribeDBClusterEndpoints (Maybe Text)

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.

describeDBClusterEndpoints_maxRecords :: Lens' DescribeDBClusterEndpoints (Maybe Int)

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.

Destructuring the Response

data DescribeDBClusterEndpointsResponse

See: newDescribeDBClusterEndpointsResponse smart constructor.

Constructors

DescribeDBClusterEndpointsResponse'

Fields

• dbClusterEndpoints :: Maybe [DBClusterEndpoint]

  Contains the details of the endpoints associated with the cluster and matching any filter conditions.

• marker :: Maybe Text

  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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeDBClusterEndpointsResponse

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Associated Types

type Rep DescribeDBClusterEndpointsResponse :: Type -> Type

Methods

from :: DescribeDBClusterEndpointsResponse -> Rep DescribeDBClusterEndpointsResponse x

to :: Rep DescribeDBClusterEndpointsResponse x -> DescribeDBClusterEndpointsResponse

Read DescribeDBClusterEndpointsResponse

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Methods

readsPrec :: Int -> ReadS DescribeDBClusterEndpointsResponse

readList :: ReadS [DescribeDBClusterEndpointsResponse]

readPrec :: ReadPrec DescribeDBClusterEndpointsResponse

readListPrec :: ReadPrec [DescribeDBClusterEndpointsResponse]

Show DescribeDBClusterEndpointsResponse

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Methods

showsPrec :: Int -> DescribeDBClusterEndpointsResponse -> ShowS

show :: DescribeDBClusterEndpointsResponse -> String

showList :: [DescribeDBClusterEndpointsResponse] -> ShowS

NFData DescribeDBClusterEndpointsResponse

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Methods

rnf :: DescribeDBClusterEndpointsResponse -> ()

Eq DescribeDBClusterEndpointsResponse

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Methods

(==) :: DescribeDBClusterEndpointsResponse -> DescribeDBClusterEndpointsResponse -> Bool

(/=) :: DescribeDBClusterEndpointsResponse -> DescribeDBClusterEndpointsResponse -> Bool

type Rep DescribeDBClusterEndpointsResponse

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

type Rep DescribeDBClusterEndpointsResponse = D1 ('MetaData "DescribeDBClusterEndpointsResponse" "Amazonka.Neptune.DescribeDBClusterEndpoints" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" 'False) (C1 ('MetaCons "DescribeDBClusterEndpointsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterEndpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBClusterEndpoint])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBClusterEndpointsResponse

Arguments

:: Int

$sel:httpStatus:DescribeDBClusterEndpointsResponse'

-> DescribeDBClusterEndpointsResponse

Create a value of DescribeDBClusterEndpointsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dbClusterEndpoints:DescribeDBClusterEndpointsResponse', describeDBClusterEndpointsResponse_dbClusterEndpoints - Contains the details of the endpoints associated with the cluster and matching any filter conditions.

DescribeDBClusterEndpoints, describeDBClusterEndpointsResponse_marker - 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.

$sel:httpStatus:DescribeDBClusterEndpointsResponse', describeDBClusterEndpointsResponse_httpStatus - The response's http status code.

Response Lenses

describeDBClusterEndpointsResponse_dbClusterEndpoints :: Lens' DescribeDBClusterEndpointsResponse (Maybe [DBClusterEndpoint])

Contains the details of the endpoints associated with the cluster and matching any filter conditions.

describeDBClusterEndpointsResponse_marker :: Lens' DescribeDBClusterEndpointsResponse (Maybe Text)

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.

describeDBClusterEndpointsResponse_httpStatus :: Lens' DescribeDBClusterEndpointsResponse Int

The response's http status code.