1.204.0

interface CfnClusterParameterGroupProps

LanguageType name
.NETAmazon.CDK.AWS.Redshift.CfnClusterParameterGroupProps
Javasoftware.amazon.awscdk.services.redshift.CfnClusterParameterGroupProps
Pythonaws_cdk.aws_redshift.CfnClusterParameterGroupProps
TypeScript @aws-cdk/aws-redshift » CfnClusterParameterGroupProps

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 * as redshift from '@aws-cdk/aws-redshift';
const cfnClusterParameterGroupProps: redshift.CfnClusterParameterGroupProps = {
  description: 'description',
  parameterGroupFamily: 'parameterGroupFamily',

  // the properties below are optional
  parameterGroupName: 'parameterGroupName',
  parameters: [{
    parameterName: 'parameterName',
    parameterValue: 'parameterValue',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
descriptionstringThe description of the parameter group.
parameterGroupFamilystringThe name of the cluster parameter group family that this cluster parameter group is compatible with.
parameterGroupName?stringThe name of the cluster parameter group.
parameters?IResolvable | IResolvable | ParameterProperty[]An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
tags?CfnTag[]The list of tags for the cluster parameter group.

description

Type: string

The description of the parameter group.

parameterGroupFamily

Type: string

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 .

parameterGroupName?

Type: string (optional)

The name of the cluster parameter group.

parameters?

Type: IResolvable | IResolvable | ParameterProperty[] (optional)

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?

Type: CfnTag[] (optional)

The list of tags for the cluster parameter group.

← PreviousNext →