Package software.amazon.awscdk.services.elasticache

Interface CfnParameterGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnParameterGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:01.518Z")
@Stability(Stable)
public interface CfnParameterGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnParameterGroup.

Example:

 // 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnParameterGroupProps.Builder	A builder for CfnParameterGroupProps
static final class	CfnParameterGroupProps.Jsii$Proxy	An implementation for CfnParameterGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnParameterGroupProps.Builder	builder()
String	getCacheParameterGroupFamily()	The name of the cache parameter group family that this cache parameter group is compatible with.
String	getDescription()	The description for this cache parameter group.
default Object	getProperties()	A comma-delimited list of parameter name/value pairs.
default List<CfnTag>	getTags()	A tag that can be added to an ElastiCache parameter group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCacheParameterGroupFamily

@Stability(Stable)
@NotNull
String getCacheParameterGroupFamily()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html#cfn-elasticache-parametergroup-cacheparametergroupfamily

getDescription

@Stability(Stable)
@NotNull
String getDescription()

The description for this cache parameter group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html#cfn-elasticache-parametergroup-description

getProperties

@Stability(Stable)
@Nullable
default Object getProperties()

A comma-delimited list of parameter name/value pairs.

For example:

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-parametergroup.html#cfn-elasticache-parametergroup-tags

builder

@Stability(Stable)
static CfnParameterGroupProps.Builder builder()

Returns:

a CfnParameterGroupProps.Builder of CfnParameterGroupProps