Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ElastiCache.DescribeEngineDefaultParameters

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the default engine and system parameter information for the specified cache engine.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeEngineDefaultParameters Source #

Represents the input of a DescribeEngineDefaultParameters operation.

See: newDescribeEngineDefaultParameters smart constructor.

Constructors

DescribeEngineDefaultParameters'

Fields

marker :: Maybe Text
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. 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 marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
cacheParameterGroupFamily :: Text
The name of the cache parameter group family.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis6.2 | redis7

Instances

Instances details

ToHeaders DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.ElastiCache.DescribeEngineDefaultParameters Methods toHeaders :: DescribeEngineDefaultParameters -> [Header] #
ToPath DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.ElastiCache.DescribeEngineDefaultParameters Methods toPath :: DescribeEngineDefaultParameters -> ByteString #
ToQuery DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.ElastiCache.DescribeEngineDefaultParameters Methods toQuery :: DescribeEngineDefaultParameters -> QueryString #
AWSPager DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.ElastiCache.DescribeEngineDefaultParameters Methods page :: DescribeEngineDefaultParameters -> AWSResponse DescribeEngineDefaultParameters -> Maybe DescribeEngineDefaultParameters #
AWSRequest DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.ElastiCache.DescribeEngineDefaultParameters Associated Types type AWSResponse DescribeEngineDefaultParameters # Methods request :: (Service -> Service) -> DescribeEngineDefaultParameters -> Request DescribeEngineDefaultParameters # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeEngineDefaultParameters -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEngineDefaultParameters))) #
Generic DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.ElastiCache.DescribeEngineDefaultParameters Associated Types type Rep DescribeEngineDefaultParameters :: Type -> Type # Methods from :: DescribeEngineDefaultParameters -> Rep DescribeEngineDefaultParameters x # to :: Rep DescribeEngineDefaultParameters x -> DescribeEngineDefaultParameters #
Read DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.ElastiCache.DescribeEngineDefaultParameters Methods readsPrec :: Int -> ReadS DescribeEngineDefaultParameters # readList :: ReadS [DescribeEngineDefaultParameters] # readPrec :: ReadPrec DescribeEngineDefaultParameters # readListPrec :: ReadPrec [DescribeEngineDefaultParameters] #
Show DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.ElastiCache.DescribeEngineDefaultParameters Methods showsPrec :: Int -> DescribeEngineDefaultParameters -> ShowS # show :: DescribeEngineDefaultParameters -> String # showList :: [DescribeEngineDefaultParameters] -> ShowS #
NFData DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.ElastiCache.DescribeEngineDefaultParameters Methods rnf :: DescribeEngineDefaultParameters -> () #
Eq DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.ElastiCache.DescribeEngineDefaultParameters Methods (==) :: DescribeEngineDefaultParameters -> DescribeEngineDefaultParameters -> Bool # (/=) :: DescribeEngineDefaultParameters -> DescribeEngineDefaultParameters -> Bool #
Hashable DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.ElastiCache.DescribeEngineDefaultParameters Methods hashWithSalt :: Int -> DescribeEngineDefaultParameters -> Int # hash :: DescribeEngineDefaultParameters -> Int #
type AWSResponse DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.ElastiCache.DescribeEngineDefaultParameters type AWSResponse DescribeEngineDefaultParameters = DescribeEngineDefaultParametersResponse
type Rep DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.ElastiCache.DescribeEngineDefaultParameters type Rep DescribeEngineDefaultParameters = D1 ('MetaData "DescribeEngineDefaultParameters" "Amazonka.ElastiCache.DescribeEngineDefaultParameters" "amazonka-elasticache-2.0-DTWyHgx8JwY7IlNovngF22" 'False) (C1 ('MetaCons "DescribeEngineDefaultParameters'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "cacheParameterGroupFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeEngineDefaultParameters Source #

Arguments

:: Text	`DescribeEngineDefaultParameters`
-> DescribeEngineDefaultParameters

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

DescribeEngineDefaultParameters, describeEngineDefaultParameters_marker - An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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

Default: 100

Constraints: minimum 20; maximum 100.

DescribeEngineDefaultParameters, describeEngineDefaultParameters_cacheParameterGroupFamily - The name of the cache parameter group family.

Request Lenses

describeEngineDefaultParameters_marker :: Lens' DescribeEngineDefaultParameters (Maybe Text) Source #

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeEngineDefaultParameters_maxRecords :: Lens' DescribeEngineDefaultParameters (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

describeEngineDefaultParameters_cacheParameterGroupFamily :: Lens' DescribeEngineDefaultParameters Text Source #

The name of the cache parameter group family.

Destructuring the Response

data DescribeEngineDefaultParametersResponse Source #

See: newDescribeEngineDefaultParametersResponse smart constructor.

Constructors

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

Instances

Instances details

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

newDescribeEngineDefaultParametersResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeEngineDefaultParametersResponse'`
-> EngineDefaults	`$sel:engineDefaults:DescribeEngineDefaultParametersResponse'`
-> DescribeEngineDefaultParametersResponse

Create a value of DescribeEngineDefaultParametersResponse 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:httpStatus:DescribeEngineDefaultParametersResponse', describeEngineDefaultParametersResponse_httpStatus - The response's http status code.

$sel:engineDefaults:DescribeEngineDefaultParametersResponse', describeEngineDefaultParametersResponse_engineDefaults - Undocumented member.

Response Lenses

describeEngineDefaultParametersResponse_httpStatus :: Lens' DescribeEngineDefaultParametersResponse Int Source #

The response's http status code.

describeEngineDefaultParametersResponse_engineDefaults :: Lens' DescribeEngineDefaultParametersResponse EngineDefaults Source #

Undocumented member.