Package software.amazon.awscdk.services.redshift

Class CfnClusterParameterGroup

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.redshift.CfnClusterParameterGroup
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:30:42.757Z") @Stability(Stable) public class CfnClusterParameterGroup extends CfnResource implements IInspectable
A CloudFormation AWS::Redshift::ClusterParameterGroup.

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

  • 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 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 -
      • 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()
      The list of tags for the cluster parameter group.

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

      You can create a custom parameter group and then associate your cluster with it. For more information, see Amazon Redshift parameter groups .

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

      You can create a custom parameter group and then associate your cluster with it. For more information, see Amazon Redshift parameter groups .

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

      For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.

      For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.

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

      For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.

      For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.

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

      For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.

      For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.