ElastiCache / Paginator / DescribeEngineDefaultParameters
DescribeEngineDefaultParameters#
- class ElastiCache.Paginator.DescribeEngineDefaultParameters#
paginator = client.get_paginator('describe_engine_default_parameters')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
ElastiCache.Client.describe_engine_default_parameters()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( CacheParameterGroupFamily='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
CacheParameterGroupFamily (string) –
[REQUIRED]
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
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'EngineDefaults': { 'CacheParameterGroupFamily': 'string', 'Marker': 'string', 'Parameters': [ { 'ParameterName': 'string', 'ParameterValue': 'string', 'Description': 'string', 'Source': 'string', 'DataType': 'string', 'AllowedValues': 'string', 'IsModifiable': True|False, 'MinimumEngineVersion': 'string', 'ChangeType': 'immediate'|'requires-reboot' }, ], 'CacheNodeTypeSpecificParameters': [ { 'ParameterName': 'string', 'Description': 'string', 'Source': 'string', 'DataType': 'string', 'AllowedValues': 'string', 'IsModifiable': True|False, 'MinimumEngineVersion': 'string', 'CacheNodeTypeSpecificValues': [ { 'CacheNodeType': 'string', 'Value': 'string' }, ], 'ChangeType': 'immediate'|'requires-reboot' }, ] }, 'NextToken': 'string' }
Response Structure
(dict) –
EngineDefaults (dict) –
Represents the output of a
DescribeEngineDefaultParameters
operation.CacheParameterGroupFamily (string) –
Specifies the name of the cache parameter group family to which the engine default parameters apply.
Valid values are:
memcached1.4
|memcached1.5
|memcached1.6
|redis2.6
|redis2.8
|redis3.2
|redis4.0
|redis5.0
|redis6.0
|redis6.x
|redis7
Marker (string) –
Provides an identifier to allow retrieval of paginated results.
Parameters (list) –
Contains a list of engine default parameters.
(dict) –
Describes an individual setting that controls some aspect of ElastiCache behavior.
ParameterName (string) –
The name of the parameter.
ParameterValue (string) –
The value of the parameter.
Description (string) –
A description of the parameter.
Source (string) –
The source of the parameter.
DataType (string) –
The valid data type for the parameter.
AllowedValues (string) –
The valid range of values for the parameter.
IsModifiable (boolean) –
Indicates whether (
true
) or not (false
) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.MinimumEngineVersion (string) –
The earliest cache engine version to which the parameter can apply.
ChangeType (string) –
Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window’s reboot. For more information, see Rebooting a Cluster.
CacheNodeTypeSpecificParameters (list) –
A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.
(dict) –
A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cluster, a
cache.m1.large
cache node type would have a largermaxmemory
value than acache.m1.small
type.ParameterName (string) –
The name of the parameter.
Description (string) –
A description of the parameter.
Source (string) –
The source of the parameter value.
DataType (string) –
The valid data type for the parameter.
AllowedValues (string) –
The valid range of values for the parameter.
IsModifiable (boolean) –
Indicates whether (
true
) or not (false
) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.MinimumEngineVersion (string) –
The earliest cache engine version to which the parameter can apply.
CacheNodeTypeSpecificValues (list) –
A list of cache node types and their corresponding values for this parameter.
(dict) –
A value that applies only to a certain cache node type.
CacheNodeType (string) –
The cache node type for which this value applies.
Value (string) –
The value for the cache node type.
ChangeType (string) –
Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window’s reboot. For more information, see Rebooting a Cluster.
NextToken (string) –
A token to resume pagination.