ElastiCache.Client.describe_engine_default_parameters(**kwargs)¶Returns the default engine and system parameter information for the specified cache engine.
See also: AWS API Documentation
Request Syntax
response = client.describe_engine_default_parameters(
CacheParameterGroupFamily='string',
MaxRecords=123,
Marker='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
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.
MaxRecords .dict
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'
},
]
}
}
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
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 larger maxmemory value than a cache.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.
Exceptions
ElastiCache.Client.exceptions.InvalidParameterValueExceptionElastiCache.Client.exceptions.InvalidParameterCombinationExceptionExamples
Returns the default engine and system parameter information for the specified cache engine.
response = client.describe_engine_default_parameters(
CacheParameterGroupFamily='redis2.8',
MaxRecords=25,
)
print(response)
Expected Output:
{
'EngineDefaults': {
'CacheNodeTypeSpecificParameters': [
{
'AllowedValues': '0-',
'CacheNodeTypeSpecificValues': [
{
'CacheNodeType': 'cache.c1.xlarge',
'Value': '650117120',
},
{
'CacheNodeType': 'cache.m1.large',
'Value': '702545920',
},
{
'CacheNodeType': 'cache.m1.medium',
'Value': '309329920',
},
{
'CacheNodeType': 'cache.m1.small',
'Value': '94371840',
},
{
'CacheNodeType': 'cache.m1.xlarge',
'Value': '1488977920',
},
{
'CacheNodeType': 'cache.m2.2xlarge',
'Value': '3502243840',
},
{
'CacheNodeType': 'cache.m2.4xlarge',
'Value': '7088373760',
},
{
'CacheNodeType': 'cache.m2.xlarge',
'Value': '1709178880',
},
{
'CacheNodeType': 'cache.m3.2xlarge',
'Value': '2998927360',
},
{
'CacheNodeType': 'cache.m3.large',
'Value': '650117120',
},
{
'CacheNodeType': 'cache.m3.medium',
'Value': '309329920',
},
{
'CacheNodeType': 'cache.m3.xlarge',
'Value': '1426063360',
},
{
'CacheNodeType': 'cache.m4.10xlarge',
'Value': '16604761424',
},
{
'CacheNodeType': 'cache.m4.2xlarge',
'Value': '3188912636',
},
{
'CacheNodeType': 'cache.m4.4xlarge',
'Value': '6525729063',
},
{
'CacheNodeType': 'cache.m4.large',
'Value': '689259315',
},
{
'CacheNodeType': 'cache.m4.xlarge',
'Value': '1532850176',
},
{
'CacheNodeType': 'cache.r3.2xlarge',
'Value': '6081740800',
},
{
'CacheNodeType': 'cache.r3.4xlarge',
'Value': '12268339200',
},
{
'CacheNodeType': 'cache.r3.8xlarge',
'Value': '24536678400',
},
{
'CacheNodeType': 'cache.r3.large',
'Value': '1468006400',
},
{
'CacheNodeType': 'cache.r3.xlarge',
'Value': '3040870400',
},
{
'CacheNodeType': 'cache.t1.micro',
'Value': '14260633',
},
{
'CacheNodeType': 'cache.t2.medium',
'Value': '346134937',
},
{
'CacheNodeType': 'cache.t2.micro',
'Value': '58195968',
},
{
'CacheNodeType': 'cache.t2.small',
'Value': '166513868',
},
],
'ChangeType': 'immediate',
'DataType': 'integer',
'Description': 'Slave client output buffer hard limit in bytes.',
'IsModifiable': False,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'client-output-buffer-limit-slave-hard-limit',
'Source': 'system',
},
{
'AllowedValues': '0-',
'CacheNodeTypeSpecificValues': [
{
'CacheNodeType': 'cache.c1.xlarge',
'Value': '650117120',
},
{
'CacheNodeType': 'cache.m1.large',
'Value': '702545920',
},
{
'CacheNodeType': 'cache.m1.medium',
'Value': '309329920',
},
{
'CacheNodeType': 'cache.m1.small',
'Value': '94371840',
},
{
'CacheNodeType': 'cache.m1.xlarge',
'Value': '1488977920',
},
{
'CacheNodeType': 'cache.m2.2xlarge',
'Value': '3502243840',
},
{
'CacheNodeType': 'cache.m2.4xlarge',
'Value': '7088373760',
},
{
'CacheNodeType': 'cache.m2.xlarge',
'Value': '1709178880',
},
{
'CacheNodeType': 'cache.m3.2xlarge',
'Value': '2998927360',
},
{
'CacheNodeType': 'cache.m3.large',
'Value': '650117120',
},
{
'CacheNodeType': 'cache.m3.medium',
'Value': '309329920',
},
{
'CacheNodeType': 'cache.m3.xlarge',
'Value': '1426063360',
},
{
'CacheNodeType': 'cache.m4.10xlarge',
'Value': '16604761424',
},
{
'CacheNodeType': 'cache.m4.2xlarge',
'Value': '3188912636',
},
{
'CacheNodeType': 'cache.m4.4xlarge',
'Value': '6525729063',
},
{
'CacheNodeType': 'cache.m4.large',
'Value': '689259315',
},
{
'CacheNodeType': 'cache.m4.xlarge',
'Value': '1532850176',
},
{
'CacheNodeType': 'cache.r3.2xlarge',
'Value': '6081740800',
},
{
'CacheNodeType': 'cache.r3.4xlarge',
'Value': '12268339200',
},
{
'CacheNodeType': 'cache.r3.8xlarge',
'Value': '24536678400',
},
{
'CacheNodeType': 'cache.r3.large',
'Value': '1468006400',
},
{
'CacheNodeType': 'cache.r3.xlarge',
'Value': '3040870400',
},
{
'CacheNodeType': 'cache.t1.micro',
'Value': '14260633',
},
{
'CacheNodeType': 'cache.t2.medium',
'Value': '346134937',
},
{
'CacheNodeType': 'cache.t2.micro',
'Value': '58195968',
},
{
'CacheNodeType': 'cache.t2.small',
'Value': '166513868',
},
],
'ChangeType': 'immediate',
'DataType': 'integer',
'Description': 'Slave client output buffer soft limit in bytes.',
'IsModifiable': False,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'client-output-buffer-limit-slave-soft-limit',
'Source': 'system',
},
{
'AllowedValues': '0-',
'CacheNodeTypeSpecificValues': [
{
'CacheNodeType': 'cache.c1.xlarge',
'Value': '6501171200',
},
{
'CacheNodeType': 'cache.m1.large',
'Value': '7025459200',
},
{
'CacheNodeType': 'cache.m1.medium',
'Value': '3093299200',
},
{
'CacheNodeType': 'cache.m1.small',
'Value': '943718400',
},
{
'CacheNodeType': 'cache.m1.xlarge',
'Value': '14889779200',
},
{
'CacheNodeType': 'cache.m2.2xlarge',
'Value': '35022438400',
},
{
'CacheNodeType': 'cache.m2.4xlarge',
'Value': '70883737600',
},
{
'CacheNodeType': 'cache.m2.xlarge',
'Value': '17091788800',
},
{
'CacheNodeType': 'cache.m3.2xlarge',
'Value': '29989273600',
},
{
'CacheNodeType': 'cache.m3.large',
'Value': '6501171200',
},
{
'CacheNodeType': 'cache.m3.medium',
'Value': '2988441600',
},
{
'CacheNodeType': 'cache.m3.xlarge',
'Value': '14260633600',
},
{
'CacheNodeType': 'cache.m4.10xlarge',
'Value': '166047614239',
},
{
'CacheNodeType': 'cache.m4.2xlarge',
'Value': '31889126359',
},
{
'CacheNodeType': 'cache.m4.4xlarge',
'Value': '65257290629',
},
{
'CacheNodeType': 'cache.m4.large',
'Value': '6892593152',
},
{
'CacheNodeType': 'cache.m4.xlarge',
'Value': '15328501760',
},
{
'CacheNodeType': 'cache.r3.2xlarge',
'Value': '62495129600',
},
{
'CacheNodeType': 'cache.r3.4xlarge',
'Value': '126458265600',
},
{
'CacheNodeType': 'cache.r3.8xlarge',
'Value': '254384537600',
},
{
'CacheNodeType': 'cache.r3.large',
'Value': '14470348800',
},
{
'CacheNodeType': 'cache.r3.xlarge',
'Value': '30513561600',
},
{
'CacheNodeType': 'cache.t1.micro',
'Value': '142606336',
},
{
'CacheNodeType': 'cache.t2.medium',
'Value': '3461349376',
},
{
'CacheNodeType': 'cache.t2.micro',
'Value': '581959680',
},
{
'CacheNodeType': 'cache.t2.small',
'Value': '1665138688',
},
],
'ChangeType': 'immediate',
'DataType': 'integer',
'Description': 'The maximum configurable amount of memory to use to store items, in bytes.',
'IsModifiable': False,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'maxmemory',
'Source': 'system',
},
],
'CacheParameterGroupFamily': 'redis2.8',
'Marker': 'bWluLXNsYXZlcy10by13cml0ZQ==',
'Parameters': [
{
'AllowedValues': 'yes,no',
'ChangeType': 'requires-reboot',
'DataType': 'string',
'Description': 'Apply rehashing or not.',
'IsModifiable': True,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'activerehashing',
'ParameterValue': 'yes',
'Source': 'system',
},
{
'AllowedValues': 'always,everysec,no',
'ChangeType': 'immediate',
'DataType': 'string',
'Description': 'fsync policy for AOF persistence',
'IsModifiable': True,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'appendfsync',
'ParameterValue': 'everysec',
'Source': 'system',
},
{
'AllowedValues': 'yes,no',
'ChangeType': 'immediate',
'DataType': 'string',
'Description': 'Enable Redis persistence.',
'IsModifiable': True,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'appendonly',
'ParameterValue': 'no',
'Source': 'system',
},
{
'AllowedValues': '0-',
'ChangeType': 'immediate',
'DataType': 'integer',
'Description': 'Normal client output buffer hard limit in bytes.',
'IsModifiable': True,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'client-output-buffer-limit-normal-hard-limit',
'ParameterValue': '0',
'Source': 'system',
},
{
'AllowedValues': '0-',
'ChangeType': 'immediate',
'DataType': 'integer',
'Description': 'Normal client output buffer soft limit in bytes.',
'IsModifiable': True,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'client-output-buffer-limit-normal-soft-limit',
'ParameterValue': '0',
'Source': 'system',
},
{
'AllowedValues': '0-',
'ChangeType': 'immediate',
'DataType': 'integer',
'Description': 'Normal client output buffer soft limit in seconds.',
'IsModifiable': True,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'client-output-buffer-limit-normal-soft-seconds',
'ParameterValue': '0',
'Source': 'system',
},
{
'AllowedValues': '0-',
'ChangeType': 'immediate',
'DataType': 'integer',
'Description': 'Pubsub client output buffer hard limit in bytes.',
'IsModifiable': True,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'client-output-buffer-limit-pubsub-hard-limit',
'ParameterValue': '33554432',
'Source': 'system',
},
{
'AllowedValues': '0-',
'ChangeType': 'immediate',
'DataType': 'integer',
'Description': 'Pubsub client output buffer soft limit in bytes.',
'IsModifiable': True,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'client-output-buffer-limit-pubsub-soft-limit',
'ParameterValue': '8388608',
'Source': 'system',
},
{
'AllowedValues': '0-',
'ChangeType': 'immediate',
'DataType': 'integer',
'Description': 'Pubsub client output buffer soft limit in seconds.',
'IsModifiable': True,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'client-output-buffer-limit-pubsub-soft-seconds',
'ParameterValue': '60',
'Source': 'system',
},
{
'AllowedValues': '0-',
'ChangeType': 'immediate',
'DataType': 'integer',
'Description': 'Slave client output buffer soft limit in seconds.',
'IsModifiable': False,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'client-output-buffer-limit-slave-soft-seconds',
'ParameterValue': '60',
'Source': 'system',
},
{
'AllowedValues': 'yes,no',
'ChangeType': 'immediate',
'DataType': 'string',
'Description': 'If enabled, clients who attempt to write to a read-only slave will be disconnected. Applicable to 2.8.23 and higher.',
'IsModifiable': True,
'MinimumEngineVersion': '2.8.23',
'ParameterName': 'close-on-slave-write',
'ParameterValue': 'yes',
'Source': 'system',
},
{
'AllowedValues': '1-1200000',
'ChangeType': 'requires-reboot',
'DataType': 'integer',
'Description': 'Set the number of databases.',
'IsModifiable': True,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'databases',
'ParameterValue': '16',
'Source': 'system',
},
{
'AllowedValues': '0-',
'ChangeType': 'immediate',
'DataType': 'integer',
'Description': 'The maximum number of hash entries in order for the dataset to be compressed.',
'IsModifiable': True,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'hash-max-ziplist-entries',
'ParameterValue': '512',
'Source': 'system',
},
{
'AllowedValues': '0-',
'ChangeType': 'immediate',
'DataType': 'integer',
'Description': 'The threshold of biggest hash entries in order for the dataset to be compressed.',
'IsModifiable': True,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'hash-max-ziplist-value',
'ParameterValue': '64',
'Source': 'system',
},
{
'AllowedValues': '0-',
'ChangeType': 'immediate',
'DataType': 'integer',
'Description': 'The maximum number of list entries in order for the dataset to be compressed.',
'IsModifiable': True,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'list-max-ziplist-entries',
'ParameterValue': '512',
'Source': 'system',
},
{
'AllowedValues': '0-',
'ChangeType': 'immediate',
'DataType': 'integer',
'Description': 'The threshold of biggest list entries in order for the dataset to be compressed.',
'IsModifiable': True,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'list-max-ziplist-value',
'ParameterValue': '64',
'Source': 'system',
},
{
'AllowedValues': '5000',
'ChangeType': 'immediate',
'DataType': 'integer',
'Description': 'Max execution time of a Lua script in milliseconds. 0 for unlimited execution without warnings.',
'IsModifiable': False,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'lua-time-limit',
'ParameterValue': '5000',
'Source': 'system',
},
{
'AllowedValues': '1-65000',
'ChangeType': 'requires-reboot',
'DataType': 'integer',
'Description': 'The maximum number of Redis clients.',
'IsModifiable': False,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'maxclients',
'ParameterValue': '65000',
'Source': 'system',
},
{
'AllowedValues': 'volatile-lru,allkeys-lru,volatile-random,allkeys-random,volatile-ttl,noeviction',
'ChangeType': 'immediate',
'DataType': 'string',
'Description': 'Max memory policy.',
'IsModifiable': True,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'maxmemory-policy',
'ParameterValue': 'volatile-lru',
'Source': 'system',
},
{
'AllowedValues': '1-',
'ChangeType': 'immediate',
'DataType': 'integer',
'Description': 'Max memory samples.',
'IsModifiable': True,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'maxmemory-samples',
'ParameterValue': '3',
'Source': 'system',
},
{
'AllowedValues': '0-',
'ChangeType': 'immediate',
'DataType': 'integer',
'Description': 'Maximum number of seconds within which the master must receive a ping from a slave to take writes. Use this parameter together with min-slaves-to-write to regulate when the master stops accepting writes. Setting this value to 0 means the master always takes writes.',
'IsModifiable': True,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'min-slaves-max-lag',
'ParameterValue': '10',
'Source': 'system',
},
{
'AllowedValues': '0-',
'ChangeType': 'immediate',
'DataType': 'integer',
'Description': 'Number of slaves that must be connected in order for master to take writes. Use this parameter together with min-slaves-max-lag to regulate when the master stops accepting writes. Setting this to 0 means the master always takes writes.',
'IsModifiable': True,
'MinimumEngineVersion': '2.8.6',
'ParameterName': 'min-slaves-to-write',
'ParameterValue': '0',
'Source': 'system',
},
],
},
'ResponseMetadata': {
'...': '...',
},
}