Skip to content
v2.278.0

CfnParameterGroupProps Struct ​

Properties for defining a CfnParameterGroup.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_elasticache as elasticache } from 'aws-cdk-lib';
const cfnParameterGroupProps: elasticache.CfnParameterGroupProps = {
  cacheParameterGroupFamily: 'cacheParameterGroupFamily',
  description: 'description',

  // the properties below are optional
  properties: {
    propertiesKey: 'properties',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_elasticache as elasticache

cfn_parameter_group_props = elasticache.CfnParameterGroupProps(
    cache_parameter_group_family="cacheParameterGroupFamily",
    description="description",

    # the properties below are optional
    properties={
        "properties_key": "properties"
    },
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.elasticache.*;

CfnParameterGroupProps cfnParameterGroupProps = CfnParameterGroupProps.builder()
        .cacheParameterGroupFamily("cacheParameterGroupFamily")
        .description("description")

        // the properties below are optional
        .properties(Map.of(
                "propertiesKey", "properties"))
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ElastiCache;

var cfnParameterGroupProps = new CfnParameterGroupProps {
    CacheParameterGroupFamily = "cacheParameterGroupFamily",
    Description = "description",

    // the properties below are optional
    Properties = new Dictionary<string, string> {
        { "propertiesKey", "properties" }
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnParameterGroupProps := &CfnParameterGroupProps{
	CacheParameterGroupFamily: jsii.String("cacheParameterGroupFamily"),
	Description: jsii.String("description"),

	// the properties below are optional
	Properties: map[string]*string{
		"propertiesKey": jsii.String("properties"),
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

cacheParameterGroupFamilystringcache_parameter_group_familystrcacheParameterGroupFamilyStringCacheParameterGroupFamilystringCacheParameterGroupFamily*string required #
The name of the cache parameter group family that this cache parameter group is compatible 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

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string required #
The description for this cache parameter group.
propertiesoptionalIResolvable | { [key: string]: string }propertiesoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]propertiesoptionalIResolvablePropertiesoptionalIResolvablePropertiesoptionalinterface{} #
A comma-delimited list of parameter name/value pairs.

For example:

"Properties" : { "cas_disabled" : "1", "chunk_size_growth_factor" : "1.02"
}
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #
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.