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.DescribeDBClusterParameters

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the detailed parameter list for a particular DB cluster parameter group.

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

See: newDescribeDBClusterParameters smart constructor.

Constructors

DescribeDBClusterParameters'

Fields

filters :: Maybe [Filter]
This parameter isn't currently supported.
marker :: Maybe Text
An optional pagination token provided by a previous DescribeDBClusterParameters 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.
source :: Maybe Text
A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.
dbClusterParameterGroupName :: Text
The name of a specific DB cluster parameter group to return parameter details for.
Constraints:
- If supplied, must match the name of an existing DBClusterParameterGroup.

Instances

Instances details

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

newDescribeDBClusterParameters Source #

Arguments

:: Text	`$sel:dbClusterParameterGroupName:DescribeDBClusterParameters'`
-> DescribeDBClusterParameters

Create a value of DescribeDBClusterParameters 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:filters:DescribeDBClusterParameters', describeDBClusterParameters_filters - This parameter isn't currently supported.

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

$sel:maxRecords:DescribeDBClusterParameters', describeDBClusterParameters_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.

$sel:source:DescribeDBClusterParameters', describeDBClusterParameters_source - A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

$sel:dbClusterParameterGroupName:DescribeDBClusterParameters', describeDBClusterParameters_dbClusterParameterGroupName - The name of a specific DB cluster parameter group to return parameter details for.

Constraints:

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

Request Lenses

describeDBClusterParameters_filters :: Lens' DescribeDBClusterParameters (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeDBClusterParameters_marker :: Lens' DescribeDBClusterParameters (Maybe Text) Source #

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

describeDBClusterParameters_maxRecords :: Lens' DescribeDBClusterParameters (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.

describeDBClusterParameters_source :: Lens' DescribeDBClusterParameters (Maybe Text) Source #

A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

describeDBClusterParameters_dbClusterParameterGroupName :: Lens' DescribeDBClusterParameters Text Source #

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

Constraints:

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

Destructuring the Response

data DescribeDBClusterParametersResponse Source #

Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.

See: newDescribeDBClusterParametersResponse smart constructor.

Constructors

DescribeDBClusterParametersResponse'
Fields marker :: Maybe Text An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords` . parameters :: Maybe [Parameter] Provides a list of parameters for the DB cluster parameter group. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeDBClusterParametersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterParameters Methods (==) :: DescribeDBClusterParametersResponse -> DescribeDBClusterParametersResponse -> Bool # (/=) :: DescribeDBClusterParametersResponse -> DescribeDBClusterParametersResponse -> Bool #
Read DescribeDBClusterParametersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterParameters Methods readsPrec :: Int -> ReadS DescribeDBClusterParametersResponse # readList :: ReadS [DescribeDBClusterParametersResponse] # readPrec :: ReadPrec DescribeDBClusterParametersResponse # readListPrec :: ReadPrec [DescribeDBClusterParametersResponse] #
Show DescribeDBClusterParametersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterParameters Methods showsPrec :: Int -> DescribeDBClusterParametersResponse -> ShowS # show :: DescribeDBClusterParametersResponse -> String # showList :: [DescribeDBClusterParametersResponse] -> ShowS #
Generic DescribeDBClusterParametersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterParameters Associated Types type Rep DescribeDBClusterParametersResponse :: Type -> Type # Methods from :: DescribeDBClusterParametersResponse -> Rep DescribeDBClusterParametersResponse x # to :: Rep DescribeDBClusterParametersResponse x -> DescribeDBClusterParametersResponse #
NFData DescribeDBClusterParametersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterParameters Methods rnf :: DescribeDBClusterParametersResponse -> () #
type Rep DescribeDBClusterParametersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBClusterParameters type Rep DescribeDBClusterParametersResponse = D1 ('MetaData "DescribeDBClusterParametersResponse" "Amazonka.RDS.DescribeDBClusterParameters" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DescribeDBClusterParametersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Parameter])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBClusterParametersResponse Source #

Arguments

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

Create a value of DescribeDBClusterParametersResponse 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:marker:DescribeDBClusterParameters', describeDBClusterParametersResponse_marker - An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

$sel:parameters:DescribeDBClusterParametersResponse', describeDBClusterParametersResponse_parameters - Provides a list of parameters for the DB cluster parameter group.

$sel:httpStatus:DescribeDBClusterParametersResponse', describeDBClusterParametersResponse_httpStatus - The response's http status code.

Response Lenses

describeDBClusterParametersResponse_marker :: Lens' DescribeDBClusterParametersResponse (Maybe Text) Source #

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

describeDBClusterParametersResponse_parameters :: Lens' DescribeDBClusterParametersResponse (Maybe [Parameter]) Source #

Provides a list of parameters for the DB cluster parameter group.

describeDBClusterParametersResponse_httpStatus :: Lens' DescribeDBClusterParametersResponse Int Source #

The response's http status code.