AWS::ElastiCache::ParameterGroup - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

AWS::ElastiCache::ParameterGroup

The AWS::ElastiCache::ParameterGroup type creates a new cache parameter group. Cache parameter groups control the parameters for a cache cluster.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::ElastiCache::ParameterGroup", "Properties" : { "CacheParameterGroupFamily" : String, "Description" : String, "Properties" : {Key : Value, ...}, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::ElastiCache::ParameterGroup Properties: CacheParameterGroupFamily: String Description: String Properties: Key : Value Tags: - Tag

Properties

CacheParameterGroupFamily

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

Required: Yes

Type: String

Update requires: Replacement

Description

The description for this cache parameter group.

Required: Yes

Type: String

Update requires: No interruption

Properties

A comma-delimited list of parameter name/value pairs. For more information, see ModifyCacheParameterGroup in the Amazon ElastiCache API Reference Guide.

For example:

"Properties" : { "cas_disabled" : "1", "chunk_size_growth_factor" : "1.02" }

Required: No

Type: Map of String

Update requires: No interruption

Tags

A tag that can be added to an ElastiCache parameter group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your parameter groups. A tag with a null Value is permitted.

Required: No

Type: List of Tag

Update requires: No interruption

Return values

Ref

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the resource name.

For more information about using the Ref function, see Ref.

Examples

JSON

{ "MyParameterGroup": { "Type": "AWS::ElastiCache::ParameterGroup", "Properties": { "Description": "MyNewParameterGroup", "CacheParameterGroupFamily": "memcached1.4", "Properties": { "cas_disabled": "1", "chunk_size_growth_factor": "1.02" } } } }

YAML

MyParameterGroup: Type: 'AWS::ElastiCache::ParameterGroup' Properties: Description: MyNewParameterGroup CacheParameterGroupFamily: memcached1.4 Properties: cas_disabled: '1' chunk_size_growth_factor: '1.02'

See also