CfnClusterParameterGroupProps

class aws_cdk.aws_redshift.CfnClusterParameterGroupProps(*, description, parameter_group_family, parameters=None, tags=None)

Bases: object

Properties for defining a CfnClusterParameterGroup.

Parameters
  • description (str) – The description of the parameter group.

  • parameter_group_family (str) – The name of the cluster parameter group family that this cluster parameter group is compatible with.

  • parameters (Union[IResolvable, Sequence[Union[IResolvable, ParameterProperty]], None]) – 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.

  • tags (Optional[Sequence[CfnTag]]) – The list of tags for the cluster parameter group.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_redshift as redshift

cfn_cluster_parameter_group_props = redshift.CfnClusterParameterGroupProps(
    description="description",
    parameter_group_family="parameterGroupFamily",

    # the properties below are optional
    parameters=[redshift.CfnClusterParameterGroup.ParameterProperty(
        parameter_name="parameterName",
        parameter_value="parameterValue"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

The description of the parameter group.

Link

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

Return type

str

parameter_group_family

The name of the cluster parameter group family that this cluster parameter group is compatible with.

Link

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

Return type

str

parameters

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.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, ParameterProperty]], None]

tags

The list of tags for the cluster parameter group.

Link

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

Return type

Optional[List[CfnTag]]