Amazon ElastiCache Elasticache Cache Parameter Group API
The Elasticache Cache Parameter Group API from Amazon ElastiCache — 5 operation(s) for elasticache cache parameter group.
The Elasticache Cache Parameter Group API from Amazon ElastiCache — 5 operation(s) for elasticache cache parameter group.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-elasticache:amazon-elasticache-cache-parameter-group-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Amazon ElastiCache Cache Parameter Group API
version: '2015-02-02'
description: Generated from AWS's published Smithy model for Amazon ElastiCache. 5 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://elasticache.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Cache Parameter Group
paths:
/?Action=CreateCacheParameterGroup:
post:
operationId: CreateCacheParameterGroup
summary: Create Cache Parameter Group
description: 'Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup. A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see: ModifyCacheParameterGroup in the ElastiCache API Reference. Parameters and Parameter Groups in the ElastiCache User Guide.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateCacheParameterGroupResult'
example:
CacheParameterGroup:
CacheParameterGroupName: custom-redis2-8
CacheParameterGroupFamily: redis2.8
Description: Custom Redis 2.8 parameter group.
'400':
description: CacheParameterGroupAlreadyExistsFault; CacheParameterGroupQuotaExceededFault; InvalidCacheParameterGroupStateFault; InvalidParameterCombinationException; InvalidParameterValueException; TagQuotaPerResourceExceeded
content:
text/xml:
schema:
$ref: '#/components/schemas/CacheParameterGroupAlreadyExistsFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: CreateCacheParameterGroup
Version:
type: string
const: '2015-02-02'
- $ref: '#/components/schemas/CreateCacheParameterGroupMessage'
example:
CacheParameterGroupName: custom-redis2-8
CacheParameterGroupFamily: redis2.8
Description: Custom Redis 2.8 parameter group.
tags:
- Cache Parameter Group
/?Action=DeleteCacheParameterGroup:
post:
operationId: DeleteCacheParameterGroup
summary: Delete Cache Parameter Group
description: Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters. You cannot delete the default cache parameter groups in your account.
responses:
'200':
description: Success
content:
text/xml:
schema:
type: string
'404':
description: CacheParameterGroupNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/CacheParameterGroupNotFoundFault'
'400':
description: InvalidCacheParameterGroupStateFault; InvalidParameterCombinationException; InvalidParameterValueException
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidCacheParameterGroupStateFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: DeleteCacheParameterGroup
Version:
type: string
const: '2015-02-02'
- $ref: '#/components/schemas/DeleteCacheParameterGroupMessage'
example:
CacheParameterGroupName: custom-mem1-4
tags:
- Cache Parameter Group
/?Action=DescribeCacheParameterGroups:
post:
operationId: DescribeCacheParameterGroups
summary: Describe Cache Parameter Groups
description: Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CacheParameterGroupsMessage'
example:
CacheParameterGroups:
- CacheParameterGroupName: custom-mem1-4
CacheParameterGroupFamily: memcached1.4
Description: Custom memcache param group
'404':
description: CacheParameterGroupNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/CacheParameterGroupNotFoundFault'
'400':
description: InvalidParameterCombinationException; InvalidParameterValueException
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidParameterCombinationException'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: DescribeCacheParameterGroups
Version:
type: string
const: '2015-02-02'
- $ref: '#/components/schemas/DescribeCacheParameterGroupsMessage'
example:
CacheParameterGroupName: custom-mem1-4
tags:
- Cache Parameter Group
/?Action=ModifyCacheParameterGroup:
post:
operationId: ModifyCacheParameterGroup
summary: Modify Cache Parameter Group
description: Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CacheParameterGroupNameMessage'
example:
CacheParameterGroupName: custom-mem1-4
'404':
description: CacheParameterGroupNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/CacheParameterGroupNotFoundFault'
'400':
description: InvalidCacheParameterGroupStateFault; InvalidGlobalReplicationGroupStateFault; InvalidParameterCombinationException; InvalidParameterValueException
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidCacheParameterGroupStateFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: ModifyCacheParameterGroup
Version:
type: string
const: '2015-02-02'
- $ref: '#/components/schemas/ModifyCacheParameterGroupMessage'
example:
CacheParameterGroupName: custom-mem1-4
ParameterNameValues:
- ParameterName: binding_protocol
ParameterValue: ascii
- ParameterName: chunk_size
ParameterValue: '96'
tags:
- Cache Parameter Group
/?Action=ResetCacheParameterGroup:
post:
operationId: ResetCacheParameterGroup
summary: Reset Cache Parameter Group
description: 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CacheParameterGroupNameMessage'
example:
CacheParameterGroupName: custom-mem1-4
'404':
description: CacheParameterGroupNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/CacheParameterGroupNotFoundFault'
'400':
description: InvalidCacheParameterGroupStateFault; InvalidGlobalReplicationGroupStateFault; InvalidParameterCombinationException; InvalidParameterValueException
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidCacheParameterGroupStateFault'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
allOf:
- type: object
required:
- Action
- Version
properties:
Action:
type: string
const: ResetCacheParameterGroup
Version:
type: string
const: '2015-02-02'
- $ref: '#/components/schemas/ResetCacheParameterGroupMessage'
example:
CacheParameterGroupName: custom-mem1-4
ResetAllParameters: true
tags:
- Cache Parameter Group
components:
schemas:
CacheParameterGroup:
type: object
properties:
CacheParameterGroupName:
type: string
description: The name of the cache parameter group.
CacheParameterGroupFamily:
type: string
description: 'The name of the cache parameter group family that this cache parameter group is compatible with. Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7'
Description:
type: string
description: The description for this cache parameter group.
IsGlobal:
type: boolean
description: Indicates whether the parameter group is associated with a Global datastore
ARN:
type: string
description: The ARN (Amazon Resource Name) of the cache parameter group.
DescribeCacheParameterGroupsMessage:
type: object
properties:
CacheParameterGroupName:
type: string
description: The name of a specific cache parameter group to return details for.
MaxRecords:
type: integer
description: '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.'
Marker:
type: string
description: 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.
InvalidCacheParameterGroupStateFault:
type: object
properties:
message:
type: string
CacheParameterGroupNameMessage:
type: object
properties:
CacheParameterGroupName:
type: string
description: The name of the cache parameter group.
CacheParameterGroupsMessage:
type: object
properties:
Marker:
type: string
description: Provides an identifier to allow retrieval of paginated results.
CacheParameterGroups:
type: array
items:
$ref: '#/components/schemas/CacheParameterGroup'
description: A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.
CacheParameterGroupAlreadyExistsFault:
type: object
properties:
message:
type: string
ParameterNameValue:
type: object
properties:
ParameterName:
type: string
description: The name of the parameter.
ParameterValue:
type: string
description: The value of the parameter.
CreateCacheParameterGroupResult:
type: object
properties:
CacheParameterGroup:
$ref: '#/components/schemas/CacheParameterGroup'
ResetCacheParameterGroupMessage:
type: object
properties:
CacheParameterGroupName:
type: string
description: The name of the cache parameter group to reset.
ResetAllParameters:
type: boolean
description: 'If true, all parameters in the cache parameter group are reset to their default values. If false, only the parameters listed by ParameterNameValues are reset to their default values. Valid values: true | false'
ParameterNameValues:
type: array
items:
$ref: '#/components/schemas/ParameterNameValue'
description: An array of parameter names to reset to their default values. If ResetAllParameters is true, do not use ParameterNameValues. If ResetAllParameters is false, you must specify the name of at least one parameter to reset.
required:
- CacheParameterGroupName
Tag:
type: object
properties:
Key:
type: string
description: The key for the tag. May not be null.
Value:
type: string
description: The tag's value. May be null.
InvalidParameterCombinationException:
type: object
properties:
message:
type: string
description: Two or more parameters that must not be used together were used together.
ModifyCacheParameterGroupMessage:
type: object
properties:
CacheParameterGroupName:
type: string
description: The name of the cache parameter group to modify.
ParameterNameValues:
type: array
items:
$ref: '#/components/schemas/ParameterNameValue'
description: An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.
required:
- CacheParameterGroupName
- ParameterNameValues
CreateCacheParameterGroupMessage:
type: object
properties:
CacheParameterGroupName:
type: string
description: A user-specified name for the cache parameter group. This value is stored as a lowercase string.
CacheParameterGroupFamily:
type: string
description: 'The name of the cache parameter group family that the cache parameter group can be used with. Valid values are: valkey8 | valkey7 | memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7'
Description:
type: string
description: A user-specified description for the cache parameter group.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
required:
- CacheParameterGroupName
- CacheParameterGroupFamily
- Description
DeleteCacheParameterGroupMessage:
type: object
properties:
CacheParameterGroupName:
type: string
description: The name of the cache parameter group to delete. The specified cache security group must not be associated with any clusters.
required:
- CacheParameterGroupName
CacheParameterGroupNotFoundFault:
type: object
properties:
message:
type: string
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: elasticache
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/elasticache/service/2015-02-02/elasticache-2015-02-02.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)