Package software.amazon.awscdk.services.redshift

Interface CfnClusterParameterGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnClusterParameterGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:35.419Z")
@Stability(Stable)
public interface CfnClusterParameterGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnClusterParameterGroup.

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.*;
 CfnClusterParameterGroupProps cfnClusterParameterGroupProps = CfnClusterParameterGroupProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnClusterParameterGroupProps.Builder	A builder for CfnClusterParameterGroupProps
static final class	CfnClusterParameterGroupProps.Jsii$Proxy	An implementation for CfnClusterParameterGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnClusterParameterGroupProps.Builder	builder()
String	getDescription()	The description of the parameter group.
String	getParameterGroupFamily()	The name of the cluster parameter group family that this cluster parameter group is compatible with.
default String	getParameterGroupName()	The name of the cluster parameter group.
default Object	getParameters()	An array of parameters to be modified.
default List<CfnTag>	getTags()	The list of tags for the cluster parameter group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Stable)
@NotNull
String getDescription()

The description of the parameter group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-description

getParameterGroupFamily

@Stability(Stable)
@NotNull
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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-parametergroupfamily

getParameterGroupName

@Stability(Stable)
@Nullable
default String getParameterGroupName()

The name of the cluster parameter group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-parametergroupname

getParameters

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-parameters

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The list of tags for the cluster parameter group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-tags

builder

@Stability(Stable)
static CfnClusterParameterGroupProps.Builder builder()

Returns:

a CfnClusterParameterGroupProps.Builder of CfnClusterParameterGroupProps