Package 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, IParameterGroupRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:04.900Z") @Stability(Stable) public class CfnParameterGroup extends CfnResource implements IInspectable, IParameterGroupRef, ITaggable
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();

See Also:

  • 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 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 - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromCacheParameterGroupName

      @Stability(Stable) @NotNull public static IParameterGroupRef fromCacheParameterGroupName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String cacheParameterGroupName)
      Creates a new IParameterGroupRef from a cacheParameterGroupName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      cacheParameterGroupName - This parameter is required.

    • 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.

    • getAttrCacheParameterGroupName

      @Stability(Stable) @NotNull public String getAttrCacheParameterGroupName()
      A user-specified name for the cache parameter group.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getParameterGroupRef

      @Stability(Stable) @NotNull public ParameterGroupReference getParameterGroupRef()
      A reference to a ParameterGroup resource.
      Specified by:
      getParameterGroupRef in interface IParameterGroupRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getCacheParameterGroupFamily

      @Stability(Stable) @NotNull public String getCacheParameterGroupFamily()
      The name of the cache parameter group family that this cache parameter group is compatible with.

    • 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.

    • 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.

      Returns union: either Mapinvalid input: '<'String, String> or IResolvable

    • setProperties

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

    • setProperties

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

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A tag that can be added to an ElastiCache parameter group.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A tag that can be added to an ElastiCache parameter group.