software.amazon.awscdk.services.elasticache

Class CfnParameterGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.elasticache.CfnParameterGroup

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.985Z")
 @Stability(value=Stable)
public class CfnParameterGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ElastiCache::ParameterGroup`.

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

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.*;
 CfnParameterGroup cfnParameterGroup = CfnParameterGroup.Builder.create(this, "MyCfnParameterGroup")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnParameterGroup.Builder A fluent builder for CfnParameterGroup.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnParameterGroup(software.constructs.Construct scope, String id, CfnParameterGroupProps props) Create a new `AWS::ElastiCache::ParameterGroup`.
protected	CfnParameterGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnParameterGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getCacheParameterGroupFamily() The name of the cache parameter group family that this cache parameter group is compatible with.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description for this cache parameter group.
Object	getProperties() A comma-delimited list of parameter name/value pairs.
TagManager	getTags() A tag that can be added to an ElastiCache parameter group.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCacheParameterGroupFamily(String value) The name of the cache parameter group family that this cache parameter group is compatible with.
void	setDescription(String value) The description for this cache parameter group.
void	setProperties(IResolvable value) A comma-delimited list of parameter name/value pairs.
void	setProperties(Map<String,String> value) A comma-delimited list of parameter name/value pairs.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnParameterGroup

protected CfnParameterGroup(software.amazon.jsii.JsiiObjectRef objRef)

CfnParameterGroup

protected CfnParameterGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnParameterGroup

@Stability(value=Stable)
public CfnParameterGroup(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  CfnParameterGroupProps props)

Create a new `AWS::ElastiCache::ParameterGroup`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager 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.

getCacheParameterGroupFamily

@Stability(value=Stable)
 @NotNull
public 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

setCacheParameterGroupFamily

@Stability(value=Stable)
public void setCacheParameterGroupFamily(@NotNull
                                                                  String value)

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

getDescription

@Stability(value=Stable)
 @NotNull
public String getDescription()

The description for this cache parameter group.

setDescription

@Stability(value=Stable)
public void setDescription(@NotNull
                                                    String value)

The description for this cache parameter group.

getProperties

@Stability(value=Stable)
 @Nullable
public Object getProperties()

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

setProperties

@Stability(value=Stable)
public void setProperties(@Nullable
                                                   IResolvable value)

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

setProperties

@Stability(value=Stable)
public void setProperties(@Nullable
                                                   Map<String,String> value)

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