Package software.amazon.awscdk.services.redshift

Class CfnClusterParameterGroup

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.redshift.CfnClusterParameterGroup
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IClusterParameterGroupRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:28.134Z") @Stability(Stable) public class CfnClusterParameterGroup extends CfnResource implements IInspectable, IClusterParameterGroupRef, ITaggable
Describes a parameter group.

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.redshift.*;
 CfnClusterParameterGroup cfnClusterParameterGroup = CfnClusterParameterGroup.Builder.create(this, "MyCfnClusterParameterGroup")
         .description("description")
         .parameterGroupFamily("parameterGroupFamily")
         // the properties below are optional
         .parameterGroupName("parameterGroupName")
         .parameters(List.of(ParameterProperty.builder()
                 .parameterName("parameterName")
                 .parameterValue("parameterValue")
                 .build()))
         .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

    • CfnClusterParameterGroup

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

    • CfnClusterParameterGroup

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

    • CfnClusterParameterGroup

      @Stability(Stable) public CfnClusterParameterGroup(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnClusterParameterGroupProps props)
      Create a new AWS::Redshift::ClusterParameterGroup.

      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

    • arnForClusterParameterGroup

      @Stability(Stable) @NotNull public static String arnForClusterParameterGroup(@NotNull IClusterParameterGroupRef resource)
      Parameters:
      resource - This parameter is required.

    • fromParameterGroupName

      @Stability(Stable) @NotNull public static IClusterParameterGroupRef fromParameterGroupName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String parameterGroupName)
      Creates a new IClusterParameterGroupRef from a parameterGroupName.

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

    • isCfnClusterParameterGroup

      @Stability(Stable) @NotNull public static Boolean isCfnClusterParameterGroup(@NotNull Object x)
      Checks whether the given object is a CfnClusterParameterGroup.

      Parameters:
      x - 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.

    • getCfnProperties

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

    • getClusterParameterGroupRef

      @Stability(Stable) @NotNull public ClusterParameterGroupReference getClusterParameterGroupRef()
      A reference to a ClusterParameterGroup resource.
      Specified by:
      getClusterParameterGroupRef in interface IClusterParameterGroupRef

    • getTags

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

    • getDescription

      @Stability(Stable) @NotNull public String getDescription()
      The description of the parameter group.

    • setDescription

      @Stability(Stable) public void setDescription(@NotNull String value)
      The description of the parameter group.

    • getParameterGroupFamily

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

    • setParameterGroupFamily

      @Stability(Stable) public void setParameterGroupFamily(@NotNull String value)
      The name of the cluster parameter group family that this cluster parameter group is compatible with.

    • getParameterGroupName

      @Stability(Stable) @Nullable public String getParameterGroupName()
      The name of the cluster parameter group.

    • setParameterGroupName

      @Stability(Stable) public void setParameterGroupName(@Nullable String value)
      The name of the cluster parameter group.

    • getParameters

      @Stability(Stable) @Nullable public Object getParameters()
      An array of parameters to be modified.

      A maximum of 20 parameters can be modified in a single request.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnClusterParameterGroup.ParameterProperty>

    • setParameters

      @Stability(Stable) public void setParameters(@Nullable IResolvable value)
      An array of parameters to be modified.

      A maximum of 20 parameters can be modified in a single request.

    • setParameters

      @Stability(Stable) public void setParameters(@Nullable List<Object> value)
      An array of parameters to be modified.

      A maximum of 20 parameters can be modified in a single request.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The list of tags for the cluster parameter group.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The list of tags for the cluster parameter group.