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.DocumentDB.DescribeEngineDefaultClusterParameters

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the default engine and system parameter information for the cluster database engine.

Synopsis

Creating a Request

data DescribeEngineDefaultClusterParameters Source #

Represents the input to DescribeEngineDefaultClusterParameters.

See: newDescribeEngineDefaultClusterParameters smart constructor.

Constructors

DescribeEngineDefaultClusterParameters'

Fields

filters :: Maybe [Filter]
This parameter is not currently supported.
marker :: Maybe Text
An optional pagination token provided by a previous 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 (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
dbParameterGroupFamily :: Text
The name of the cluster parameter group family to return the engine parameter information for.

Instances

Instances details

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

newDescribeEngineDefaultClusterParameters Source #

Arguments

:: Text	`$sel:dbParameterGroupFamily:DescribeEngineDefaultClusterParameters'`
-> DescribeEngineDefaultClusterParameters

Create a value of DescribeEngineDefaultClusterParameters 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:DescribeEngineDefaultClusterParameters', describeEngineDefaultClusterParameters_filters - This parameter is not currently supported.

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

$sel:maxRecords:DescribeEngineDefaultClusterParameters', describeEngineDefaultClusterParameters_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

$sel:dbParameterGroupFamily:DescribeEngineDefaultClusterParameters', describeEngineDefaultClusterParameters_dbParameterGroupFamily - The name of the cluster parameter group family to return the engine parameter information for.

Request Lenses

describeEngineDefaultClusterParameters_filters :: Lens' DescribeEngineDefaultClusterParameters (Maybe [Filter]) Source #

This parameter is not currently supported.

describeEngineDefaultClusterParameters_marker :: Lens' DescribeEngineDefaultClusterParameters (Maybe Text) Source #

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

describeEngineDefaultClusterParameters_maxRecords :: Lens' DescribeEngineDefaultClusterParameters (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 (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

describeEngineDefaultClusterParameters_dbParameterGroupFamily :: Lens' DescribeEngineDefaultClusterParameters Text Source #

The name of the cluster parameter group family to return the engine parameter information for.

Destructuring the Response

data DescribeEngineDefaultClusterParametersResponse Source #

See: newDescribeEngineDefaultClusterParametersResponse smart constructor.

Constructors

DescribeEngineDefaultClusterParametersResponse'
Fields engineDefaults :: Maybe EngineDefaults httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeEngineDefaultClusterParametersResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters Methods (==) :: DescribeEngineDefaultClusterParametersResponse -> DescribeEngineDefaultClusterParametersResponse -> Bool # (/=) :: DescribeEngineDefaultClusterParametersResponse -> DescribeEngineDefaultClusterParametersResponse -> Bool #
Read DescribeEngineDefaultClusterParametersResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters Methods readsPrec :: Int -> ReadS DescribeEngineDefaultClusterParametersResponse # readList :: ReadS [DescribeEngineDefaultClusterParametersResponse] # readPrec :: ReadPrec DescribeEngineDefaultClusterParametersResponse # readListPrec :: ReadPrec [DescribeEngineDefaultClusterParametersResponse] #
Show DescribeEngineDefaultClusterParametersResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters Methods showsPrec :: Int -> DescribeEngineDefaultClusterParametersResponse -> ShowS # show :: DescribeEngineDefaultClusterParametersResponse -> String # showList :: [DescribeEngineDefaultClusterParametersResponse] -> ShowS #
Generic DescribeEngineDefaultClusterParametersResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters Associated Types type Rep DescribeEngineDefaultClusterParametersResponse :: Type -> Type # Methods from :: DescribeEngineDefaultClusterParametersResponse -> Rep DescribeEngineDefaultClusterParametersResponse x # to :: Rep DescribeEngineDefaultClusterParametersResponse x -> DescribeEngineDefaultClusterParametersResponse #
NFData DescribeEngineDefaultClusterParametersResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters Methods rnf :: DescribeEngineDefaultClusterParametersResponse -> () #
type Rep DescribeEngineDefaultClusterParametersResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters type Rep DescribeEngineDefaultClusterParametersResponse = D1 ('MetaData "DescribeEngineDefaultClusterParametersResponse" "Amazonka.DocumentDB.DescribeEngineDefaultClusterParameters" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DescribeEngineDefaultClusterParametersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "engineDefaults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EngineDefaults)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeEngineDefaultClusterParametersResponse Source #

Arguments

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

Create a value of DescribeEngineDefaultClusterParametersResponse 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:engineDefaults:DescribeEngineDefaultClusterParametersResponse', describeEngineDefaultClusterParametersResponse_engineDefaults - Undocumented member.

$sel:httpStatus:DescribeEngineDefaultClusterParametersResponse', describeEngineDefaultClusterParametersResponse_httpStatus - The response's http status code.

Response Lenses

describeEngineDefaultClusterParametersResponse_engineDefaults :: Lens' DescribeEngineDefaultClusterParametersResponse (Maybe EngineDefaults) Source #

Undocumented member.

describeEngineDefaultClusterParametersResponse_httpStatus :: Lens' DescribeEngineDefaultClusterParametersResponse Int Source #

The response's http status code.