ResetCacheParameterGroup
Modifies the parameters of a cache parameter group to the engine or system default
value. You can reset specific parameters by submitting a list of parameter names. To
reset the entire cache parameter group, specify the ResetAllParameters
and
CacheParameterGroupName
parameters.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- CacheParameterGroupName
-
The name of the cache parameter group to reset.
Type: String
Required: Yes
- ParameterNameValues.ParameterNameValue.N
-
An array of parameter names to reset to their default values. If
ResetAllParameters
istrue
, do not useParameterNameValues
. IfResetAllParameters
isfalse
, you must specify the name of at least one parameter to reset.Type: Array of ParameterNameValue objects
Required: No
- ResetAllParameters
-
If
true
, all parameters in the cache parameter group are reset to their default values. Iffalse
, only the parameters listed byParameterNameValues
are reset to their default values.Valid values:
true
|false
Type: Boolean
Required: No
Response Elements
The following element is returned by the service.
- CacheParameterGroupName
-
The name of the cache parameter group.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- CacheParameterGroupNotFound
-
The requested cache parameter group name does not refer to an existing cache parameter group.
HTTP Status Code: 404
- InvalidCacheParameterGroupState
-
The current state of the cache parameter group does not allow the requested operation to occur.
HTTP Status Code: 400
- InvalidGlobalReplicationGroupState
-
The Global datastore is not available or in primary-only state.
HTTP Status Code: 400
- InvalidParameterCombination
-
Two or more incompatible parameters were specified.
HTTP Status Code: 400
- InvalidParameterValue
-
The value for a parameter is invalid.
HTTP Status Code: 400
Examples
ResetCacheParameterGroup
This example illustrates one usage of ResetCacheParameterGroup.
Sample Request
https://elasticache.us-west-2.amazonaws.com/
?Action=ResetCacheParameterGroup
&ResetAllParameters=true
&CacheParameterGroupName=mycacheparametergroup1
&Version=2015-02-02
&SignatureVersion=4
&SignatureMethod=HmacSHA256
&Timestamp=20150202T192317Z
&X-Amz-Credential=<credential>
Sample Response
<ResetCacheParameterGroupResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
<ResetCacheParameterGroupResult>
<CacheParameterGroupName>mycacheparametergroup1</CacheParameterGroupName>
</ResetCacheParameterGroupResult>
<ResponseMetadata>
<RequestId>cb7cc855-b9d2-11e3-8a16-7978bb24ffdf</RequestId>
</ResponseMetadata>
</ResetCacheParameterGroupResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: