amazonka-neptune-2.0: Amazon Neptune SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Neptune.DescribeDBClusterEndpoints

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

  • 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

Instances details
ToHeaders DescribeDBClusterEndpoints Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

ToPath DescribeDBClusterEndpoints Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

ToQuery DescribeDBClusterEndpoints Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

AWSPager DescribeDBClusterEndpoints Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

AWSRequest DescribeDBClusterEndpoints Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Generic DescribeDBClusterEndpoints Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Associated Types

type Rep DescribeDBClusterEndpoints :: Type -> Type #

Read DescribeDBClusterEndpoints Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Show DescribeDBClusterEndpoints Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

NFData DescribeDBClusterEndpoints Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Eq DescribeDBClusterEndpoints Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Hashable DescribeDBClusterEndpoints Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

type AWSResponse DescribeDBClusterEndpoints Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

type Rep DescribeDBClusterEndpoints Source # 
Instance details

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 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:

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

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

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

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
Generic DescribeDBClusterEndpointsResponse Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Associated Types

type Rep DescribeDBClusterEndpointsResponse :: Type -> Type #

Read DescribeDBClusterEndpointsResponse Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Show DescribeDBClusterEndpointsResponse Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

NFData DescribeDBClusterEndpointsResponse Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

Eq DescribeDBClusterEndpointsResponse Source # 
Instance details

Defined in Amazonka.Neptune.DescribeDBClusterEndpoints

type Rep DescribeDBClusterEndpointsResponse Source # 
Instance details

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

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]) 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.