CfnParameterGroupProps

class aws_cdk.aws_elasticache.CfnParameterGroupProps(*, cache_parameter_group_family, description, properties=None, tags=None)

Bases: object

Properties for defining a CfnParameterGroup.

Parameters
  • cache_parameter_group_family (str) – 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

  • description (str) – The description for this cache parameter group.

  • properties (Union[IResolvable, Mapping[str, str], None]) – 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” }

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-parameter-group.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.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"
    )]
)

Attributes

cache_parameter_group_family

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-parameter-group.html#cfn-elasticache-parametergroup-cacheparametergroupfamily

Return type

str

description

The description for this cache parameter group.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-parameter-group.html#cfn-elasticache-parametergroup-description

Return type

str

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"
}
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-parameter-group.html#cfn-elasticache-parametergroup-properties

Return type

Union[IResolvable, Mapping[str, str], None]

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-parameter-group.html#cfn-elasticache-parametergroup-tags

Return type

Optional[List[CfnTag]]