amazonka-rds-2.0: Amazon Relational Database Service 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.RDS.DescribeDBClusterParameterGroups

Description

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

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

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeDBClusterParameterGroups Source #

See: newDescribeDBClusterParameterGroups smart constructor.

Constructors

DescribeDBClusterParameterGroups' 

Fields

  • dbClusterParameterGroupName :: Maybe Text

    The name of a specific DB cluster parameter group to return details for.

    Constraints:

    • If supplied, must match the name of an existing DBClusterParameterGroup.
  • filters :: Maybe [Filter]

    This parameter isn't currently supported.

  • marker :: Maybe Text

    An optional pagination token provided by a previous DescribeDBClusterParameterGroups 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 DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterParameterGroups

Methods

toHeaders :: DescribeDBClusterParameterGroups -> [Header] #

ToPath DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterParameterGroups

Methods

toPath :: DescribeDBClusterParameterGroups -> ByteString #

ToQuery DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterParameterGroups

Methods

toQuery :: DescribeDBClusterParameterGroups -> QueryString #

AWSPager DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterParameterGroups

Methods

page :: DescribeDBClusterParameterGroups -> AWSResponse DescribeDBClusterParameterGroups -> Maybe DescribeDBClusterParameterGroups #

AWSRequest DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterParameterGroups

Associated Types

type AWSResponse DescribeDBClusterParameterGroups #

Methods

request :: (Service -> Service) -> DescribeDBClusterParameterGroups -> Request DescribeDBClusterParameterGroups #

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

Generic DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterParameterGroups

Associated Types

type Rep DescribeDBClusterParameterGroups :: Type -> Type #

Methods

from :: DescribeDBClusterParameterGroups -> Rep DescribeDBClusterParameterGroups x #

to :: Rep DescribeDBClusterParameterGroups x -> DescribeDBClusterParameterGroups #

Read DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterParameterGroups

Methods

readsPrec :: Int -> ReadS DescribeDBClusterParameterGroups #

readList :: ReadS [DescribeDBClusterParameterGroups] #

readPrec :: ReadPrec DescribeDBClusterParameterGroups #

readListPrec :: ReadPrec [DescribeDBClusterParameterGroups] #

Show DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterParameterGroups

Methods

showsPrec :: Int -> DescribeDBClusterParameterGroups -> ShowS #

show :: DescribeDBClusterParameterGroups -> String #

showList :: [DescribeDBClusterParameterGroups] -> ShowS #

NFData DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterParameterGroups

Methods

rnf :: DescribeDBClusterParameterGroups -> () #

Eq DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterParameterGroups

Methods

(==) :: DescribeDBClusterParameterGroups -> DescribeDBClusterParameterGroups -> Bool #

(/=) :: DescribeDBClusterParameterGroups -> DescribeDBClusterParameterGroups -> Bool #

Hashable DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterParameterGroups

Methods

hashWithSalt :: Int -> DescribeDBClusterParameterGroups -> Int #

hash :: DescribeDBClusterParameterGroups -> Int #

type AWSResponse DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterParameterGroups

type AWSResponse DescribeDBClusterParameterGroups = DescribeDBClusterParameterGroupsResponse
type Rep DescribeDBClusterParameterGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterParameterGroups

type Rep DescribeDBClusterParameterGroups = D1 ('MetaData "DescribeDBClusterParameterGroups" "Amazonka.RDS.DescribeDBClusterParameterGroups" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeDBClusterParameterGroups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbClusterParameterGroupName") '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)))))

newDescribeDBClusterParameterGroups :: DescribeDBClusterParameterGroups Source #

Create a value of DescribeDBClusterParameterGroups 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:

DescribeDBClusterParameterGroups, describeDBClusterParameterGroups_dbClusterParameterGroupName - The name of a specific DB cluster parameter group to return details for.

Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.

$sel:filters:DescribeDBClusterParameterGroups', describeDBClusterParameterGroups_filters - This parameter isn't currently supported.

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

$sel:maxRecords:DescribeDBClusterParameterGroups', describeDBClusterParameterGroups_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

describeDBClusterParameterGroups_dbClusterParameterGroupName :: Lens' DescribeDBClusterParameterGroups (Maybe Text) Source #

The name of a specific DB cluster parameter group to return details for.

Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.

describeDBClusterParameterGroups_filters :: Lens' DescribeDBClusterParameterGroups (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeDBClusterParameterGroups_marker :: Lens' DescribeDBClusterParameterGroups (Maybe Text) Source #

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

describeDBClusterParameterGroups_maxRecords :: Lens' DescribeDBClusterParameterGroups (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 DescribeDBClusterParameterGroupsResponse Source #

See: newDescribeDBClusterParameterGroupsResponse smart constructor.

Constructors

DescribeDBClusterParameterGroupsResponse' 

Fields

Instances

Instances details
Generic DescribeDBClusterParameterGroupsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterParameterGroups

Associated Types

type Rep DescribeDBClusterParameterGroupsResponse :: Type -> Type #

Methods

from :: DescribeDBClusterParameterGroupsResponse -> Rep DescribeDBClusterParameterGroupsResponse x #

to :: Rep DescribeDBClusterParameterGroupsResponse x -> DescribeDBClusterParameterGroupsResponse #

Read DescribeDBClusterParameterGroupsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterParameterGroups

Methods

readsPrec :: Int -> ReadS DescribeDBClusterParameterGroupsResponse #

readList :: ReadS [DescribeDBClusterParameterGroupsResponse] #

readPrec :: ReadPrec DescribeDBClusterParameterGroupsResponse #

readListPrec :: ReadPrec [DescribeDBClusterParameterGroupsResponse] #

Show DescribeDBClusterParameterGroupsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterParameterGroups

Methods

showsPrec :: Int -> DescribeDBClusterParameterGroupsResponse -> ShowS #

show :: DescribeDBClusterParameterGroupsResponse -> String #

showList :: [DescribeDBClusterParameterGroupsResponse] -> ShowS #

NFData DescribeDBClusterParameterGroupsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterParameterGroups

Methods

rnf :: DescribeDBClusterParameterGroupsResponse -> () #

Eq DescribeDBClusterParameterGroupsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterParameterGroups

Methods

(==) :: DescribeDBClusterParameterGroupsResponse -> DescribeDBClusterParameterGroupsResponse -> Bool #

(/=) :: DescribeDBClusterParameterGroupsResponse -> DescribeDBClusterParameterGroupsResponse -> Bool #

type Rep DescribeDBClusterParameterGroupsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBClusterParameterGroups

type Rep DescribeDBClusterParameterGroupsResponse = D1 ('MetaData "DescribeDBClusterParameterGroupsResponse" "Amazonka.RDS.DescribeDBClusterParameterGroups" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeDBClusterParameterGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterParameterGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBClusterParameterGroup])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBClusterParameterGroupsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeDBClusterParameterGroupsResponse'

-> DescribeDBClusterParameterGroupsResponse 

Create a value of DescribeDBClusterParameterGroupsResponse 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:dbClusterParameterGroups:DescribeDBClusterParameterGroupsResponse', describeDBClusterParameterGroupsResponse_dbClusterParameterGroups - A list of DB cluster parameter groups.

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

$sel:httpStatus:DescribeDBClusterParameterGroupsResponse', describeDBClusterParameterGroupsResponse_httpStatus - The response's http status code.

Response Lenses

describeDBClusterParameterGroupsResponse_dbClusterParameterGroups :: Lens' DescribeDBClusterParameterGroupsResponse (Maybe [DBClusterParameterGroup]) Source #

A list of DB cluster parameter groups.

describeDBClusterParameterGroupsResponse_marker :: Lens' DescribeDBClusterParameterGroupsResponse (Maybe Text) Source #

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

describeDBClusterParameterGroupsResponse_httpStatus :: Lens' DescribeDBClusterParameterGroupsResponse Int Source #

The response's http status code.