Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Neptune.DescribeDBClusterEndpoints

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

Creating a Request

data DescribeDBClusterEndpoints Source #

See: newDescribeDBClusterEndpoints smart constructor.

Constructors

DescribeDBClusterEndpoints'

Fields

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.
dbClusterEndpointIdentifier :: Maybe Text
The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
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

Instances details

Eq DescribeDBClusterEndpoints Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterEndpoints Methods (==) :: DescribeDBClusterEndpoints -> DescribeDBClusterEndpoints -> Bool # (/=) :: DescribeDBClusterEndpoints -> DescribeDBClusterEndpoints -> Bool #
Read DescribeDBClusterEndpoints Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterEndpoints Methods readsPrec :: Int -> ReadS DescribeDBClusterEndpoints # readList :: ReadS [DescribeDBClusterEndpoints] # readPrec :: ReadPrec DescribeDBClusterEndpoints # readListPrec :: ReadPrec [DescribeDBClusterEndpoints] #
Show DescribeDBClusterEndpoints Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterEndpoints Methods showsPrec :: Int -> DescribeDBClusterEndpoints -> ShowS # show :: DescribeDBClusterEndpoints -> String # showList :: [DescribeDBClusterEndpoints] -> ShowS #
Generic DescribeDBClusterEndpoints Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterEndpoints Associated Types type Rep DescribeDBClusterEndpoints :: Type -> Type # Methods from :: DescribeDBClusterEndpoints -> Rep DescribeDBClusterEndpoints x # to :: Rep DescribeDBClusterEndpoints x -> DescribeDBClusterEndpoints #
NFData DescribeDBClusterEndpoints Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterEndpoints Methods rnf :: DescribeDBClusterEndpoints -> () #
Hashable DescribeDBClusterEndpoints Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterEndpoints Methods hashWithSalt :: Int -> DescribeDBClusterEndpoints -> Int # hash :: DescribeDBClusterEndpoints -> Int #
AWSPager DescribeDBClusterEndpoints Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterEndpoints Methods page :: DescribeDBClusterEndpoints -> AWSResponse DescribeDBClusterEndpoints -> Maybe DescribeDBClusterEndpoints #
AWSRequest DescribeDBClusterEndpoints Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterEndpoints Associated Types type AWSResponse DescribeDBClusterEndpoints # Methods request :: DescribeDBClusterEndpoints -> Request DescribeDBClusterEndpoints # response :: MonadResource m => Logger -> Service -> Proxy DescribeDBClusterEndpoints -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDBClusterEndpoints))) #
ToHeaders DescribeDBClusterEndpoints Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterEndpoints Methods toHeaders :: DescribeDBClusterEndpoints -> [Header] #
ToPath DescribeDBClusterEndpoints Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterEndpoints Methods toPath :: DescribeDBClusterEndpoints -> ByteString #
ToQuery DescribeDBClusterEndpoints Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterEndpoints Methods toQuery :: DescribeDBClusterEndpoints -> QueryString #
type Rep DescribeDBClusterEndpoints Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterEndpoints type Rep DescribeDBClusterEndpoints = D1 ('MetaData "DescribeDBClusterEndpoints" "Amazonka.Neptune.DescribeDBClusterEndpoints" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" 'False) (C1 ('MetaCons "DescribeDBClusterEndpoints'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :: (S1 ('MetaSel ('Just "dbClusterEndpointIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))
type AWSResponse DescribeDBClusterEndpoints Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterEndpoints type AWSResponse DescribeDBClusterEndpoints = DescribeDBClusterEndpointsResponse

newDescribeDBClusterEndpoints :: DescribeDBClusterEndpoints Source #

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:

$sel:dbClusterIdentifier: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.

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

$sel:marker: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_dbClusterIdentifier :: Lens' DescribeDBClusterEndpoints (Maybe Text) Source #

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]) Source #

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_dbClusterEndpointIdentifier :: Lens' DescribeDBClusterEndpoints (Maybe Text) Source #

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

describeDBClusterEndpoints_marker :: Lens' DescribeDBClusterEndpoints (Maybe Text) Source #

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) Source #

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 Source #

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

Instances details

Eq DescribeDBClusterEndpointsResponse Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterEndpoints Methods (==) :: DescribeDBClusterEndpointsResponse -> DescribeDBClusterEndpointsResponse -> Bool # (/=) :: DescribeDBClusterEndpointsResponse -> DescribeDBClusterEndpointsResponse -> Bool #
Read DescribeDBClusterEndpointsResponse Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterEndpoints Methods readsPrec :: Int -> ReadS DescribeDBClusterEndpointsResponse # readList :: ReadS [DescribeDBClusterEndpointsResponse] # readPrec :: ReadPrec DescribeDBClusterEndpointsResponse # readListPrec :: ReadPrec [DescribeDBClusterEndpointsResponse] #
Show DescribeDBClusterEndpointsResponse Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterEndpoints Methods showsPrec :: Int -> DescribeDBClusterEndpointsResponse -> ShowS # show :: DescribeDBClusterEndpointsResponse -> String # showList :: [DescribeDBClusterEndpointsResponse] -> ShowS #
Generic DescribeDBClusterEndpointsResponse Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterEndpoints Associated Types type Rep DescribeDBClusterEndpointsResponse :: Type -> Type # Methods from :: DescribeDBClusterEndpointsResponse -> Rep DescribeDBClusterEndpointsResponse x # to :: Rep DescribeDBClusterEndpointsResponse x -> DescribeDBClusterEndpointsResponse #
NFData DescribeDBClusterEndpointsResponse Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterEndpoints Methods rnf :: DescribeDBClusterEndpointsResponse -> () #
type Rep DescribeDBClusterEndpointsResponse Source #
Instance details Defined in Amazonka.Neptune.DescribeDBClusterEndpoints type Rep DescribeDBClusterEndpointsResponse = D1 ('MetaData "DescribeDBClusterEndpointsResponse" "Amazonka.Neptune.DescribeDBClusterEndpoints" "libZSservicesZSamazonka-neptuneZSamazonka-neptune" '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 Source #

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.

$sel:marker: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]) Source #

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

describeDBClusterEndpointsResponse_marker :: Lens' DescribeDBClusterEndpointsResponse (Maybe Text) Source #

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 Source #

The response's http status code.