Package software.amazon.awscdk.services.elasticache

Class CfnParameterGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.elasticache.CfnParameterGroup
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.454Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnParameterGroup

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

    • CfnParameterGroup

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

    • CfnParameterGroup

      @Stability(Stable) public CfnParameterGroup(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(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(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 | redis7

    • setCacheParameterGroupFamily

      @Stability(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 | redis7

    • getDescription

      @Stability(Stable) @NotNull public String getDescription()
      The description for this cache parameter group.

    • setDescription

      @Stability(Stable) public void setDescription(@NotNull String value)
      The description for this cache parameter group.

    • getProperties

      @Stability(Stable) @Nullable public Object getProperties()
      A comma-delimited list of parameter name/value pairs.

      For example: 

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

    • setProperties

      @Stability(Stable) public void setProperties(@Nullable IResolvable value)
      A comma-delimited list of parameter name/value pairs.

      For example: 

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

    • setProperties

      @Stability(Stable) public void setProperties(@Nullable Map<String,String> value)
      A comma-delimited list of parameter name/value pairs.

      For example: 

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