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.RDS.DescribeGlobalClusters

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about Aurora global database clusters. This API supports pagination.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeGlobalClusters Source #

See: newDescribeGlobalClusters smart constructor.

Constructors

DescribeGlobalClusters'

Fields

globalClusterIdentifier :: Maybe Text
The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
- If supplied, must match an existing DBClusterIdentifier.
filters :: Maybe [Filter]
This parameter isn't currently supported.
marker :: Maybe Text
An optional pagination token provided by a previous DescribeGlobalClusters 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 that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.

Instances

Instances details

Eq DescribeGlobalClusters Source #
Instance details Defined in Amazonka.RDS.DescribeGlobalClusters Methods (==) :: DescribeGlobalClusters -> DescribeGlobalClusters -> Bool # (/=) :: DescribeGlobalClusters -> DescribeGlobalClusters -> Bool #
Read DescribeGlobalClusters Source #
Instance details Defined in Amazonka.RDS.DescribeGlobalClusters Methods readsPrec :: Int -> ReadS DescribeGlobalClusters # readList :: ReadS [DescribeGlobalClusters] # readPrec :: ReadPrec DescribeGlobalClusters # readListPrec :: ReadPrec [DescribeGlobalClusters] #
Show DescribeGlobalClusters Source #
Instance details Defined in Amazonka.RDS.DescribeGlobalClusters Methods showsPrec :: Int -> DescribeGlobalClusters -> ShowS # show :: DescribeGlobalClusters -> String # showList :: [DescribeGlobalClusters] -> ShowS #
Generic DescribeGlobalClusters Source #
Instance details Defined in Amazonka.RDS.DescribeGlobalClusters Associated Types type Rep DescribeGlobalClusters :: Type -> Type # Methods from :: DescribeGlobalClusters -> Rep DescribeGlobalClusters x # to :: Rep DescribeGlobalClusters x -> DescribeGlobalClusters #
NFData DescribeGlobalClusters Source #
Instance details Defined in Amazonka.RDS.DescribeGlobalClusters Methods rnf :: DescribeGlobalClusters -> () #
Hashable DescribeGlobalClusters Source #
Instance details Defined in Amazonka.RDS.DescribeGlobalClusters Methods hashWithSalt :: Int -> DescribeGlobalClusters -> Int # hash :: DescribeGlobalClusters -> Int #
AWSPager DescribeGlobalClusters Source #
Instance details Defined in Amazonka.RDS.DescribeGlobalClusters Methods page :: DescribeGlobalClusters -> AWSResponse DescribeGlobalClusters -> Maybe DescribeGlobalClusters #
AWSRequest DescribeGlobalClusters Source #
Instance details Defined in Amazonka.RDS.DescribeGlobalClusters Associated Types type AWSResponse DescribeGlobalClusters # Methods request :: DescribeGlobalClusters -> Request DescribeGlobalClusters # response :: MonadResource m => Logger -> Service -> Proxy DescribeGlobalClusters -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeGlobalClusters))) #
ToHeaders DescribeGlobalClusters Source #
Instance details Defined in Amazonka.RDS.DescribeGlobalClusters Methods toHeaders :: DescribeGlobalClusters -> [Header] #
ToPath DescribeGlobalClusters Source #
Instance details Defined in Amazonka.RDS.DescribeGlobalClusters Methods toPath :: DescribeGlobalClusters -> ByteString #
ToQuery DescribeGlobalClusters Source #
Instance details Defined in Amazonka.RDS.DescribeGlobalClusters Methods toQuery :: DescribeGlobalClusters -> QueryString #
type Rep DescribeGlobalClusters Source #
Instance details Defined in Amazonka.RDS.DescribeGlobalClusters type Rep DescribeGlobalClusters = D1 ('MetaData "DescribeGlobalClusters" "Amazonka.RDS.DescribeGlobalClusters" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DescribeGlobalClusters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "globalClusterIdentifier") '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)))))
type AWSResponse DescribeGlobalClusters Source #
Instance details Defined in Amazonka.RDS.DescribeGlobalClusters type AWSResponse DescribeGlobalClusters = DescribeGlobalClustersResponse

newDescribeGlobalClusters :: DescribeGlobalClusters Source #

Create a value of DescribeGlobalClusters 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:globalClusterIdentifier:DescribeGlobalClusters', describeGlobalClusters_globalClusterIdentifier - The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

Constraints:

If supplied, must match an existing DBClusterIdentifier.

$sel:filters:DescribeGlobalClusters', describeGlobalClusters_filters - This parameter isn't currently supported.

$sel:marker:DescribeGlobalClusters', describeGlobalClusters_marker - An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

$sel:maxRecords:DescribeGlobalClusters', describeGlobalClusters_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 that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Request Lenses

describeGlobalClusters_globalClusterIdentifier :: Lens' DescribeGlobalClusters (Maybe Text) Source #

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

Constraints:

If supplied, must match an existing DBClusterIdentifier.

describeGlobalClusters_filters :: Lens' DescribeGlobalClusters (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeGlobalClusters_marker :: Lens' DescribeGlobalClusters (Maybe Text) Source #

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

describeGlobalClusters_maxRecords :: Lens' DescribeGlobalClusters (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 that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Destructuring the Response

data DescribeGlobalClustersResponse Source #

See: newDescribeGlobalClustersResponse smart constructor.

Constructors

DescribeGlobalClustersResponse'
Fields globalClusters :: Maybe [GlobalCluster] The list of global clusters returned by this request. marker :: Maybe Text An optional pagination token provided by a previous `DescribeGlobalClusters` 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 DescribeGlobalClustersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeGlobalClusters Methods (==) :: DescribeGlobalClustersResponse -> DescribeGlobalClustersResponse -> Bool # (/=) :: DescribeGlobalClustersResponse -> DescribeGlobalClustersResponse -> Bool #
Read DescribeGlobalClustersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeGlobalClusters Methods readsPrec :: Int -> ReadS DescribeGlobalClustersResponse # readList :: ReadS [DescribeGlobalClustersResponse] # readPrec :: ReadPrec DescribeGlobalClustersResponse # readListPrec :: ReadPrec [DescribeGlobalClustersResponse] #
Show DescribeGlobalClustersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeGlobalClusters Methods showsPrec :: Int -> DescribeGlobalClustersResponse -> ShowS # show :: DescribeGlobalClustersResponse -> String # showList :: [DescribeGlobalClustersResponse] -> ShowS #
Generic DescribeGlobalClustersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeGlobalClusters Associated Types type Rep DescribeGlobalClustersResponse :: Type -> Type # Methods from :: DescribeGlobalClustersResponse -> Rep DescribeGlobalClustersResponse x # to :: Rep DescribeGlobalClustersResponse x -> DescribeGlobalClustersResponse #
NFData DescribeGlobalClustersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeGlobalClusters Methods rnf :: DescribeGlobalClustersResponse -> () #
type Rep DescribeGlobalClustersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeGlobalClusters type Rep DescribeGlobalClustersResponse = D1 ('MetaData "DescribeGlobalClustersResponse" "Amazonka.RDS.DescribeGlobalClusters" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DescribeGlobalClustersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "globalClusters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GlobalCluster])) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeGlobalClustersResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeGlobalClustersResponse'`
-> DescribeGlobalClustersResponse

Create a value of DescribeGlobalClustersResponse 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:globalClusters:DescribeGlobalClustersResponse', describeGlobalClustersResponse_globalClusters - The list of global clusters returned by this request.

$sel:marker:DescribeGlobalClusters', describeGlobalClustersResponse_marker - An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

$sel:httpStatus:DescribeGlobalClustersResponse', describeGlobalClustersResponse_httpStatus - The response's http status code.

Response Lenses

describeGlobalClustersResponse_globalClusters :: Lens' DescribeGlobalClustersResponse (Maybe [GlobalCluster]) Source #

The list of global clusters returned by this request.

describeGlobalClustersResponse_marker :: Lens' DescribeGlobalClustersResponse (Maybe Text) Source #

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

describeGlobalClustersResponse_httpStatus :: Lens' DescribeGlobalClustersResponse Int Source #

The response's http status code.