class ClusterParameterGroup (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Redshift.Alpha.ClusterParameterGroup
Go	github.com/aws/aws-cdk-go/awscdkredshiftalpha/v2#ClusterParameterGroup
Java	software.amazon.awscdk.services.redshift.alpha.ClusterParameterGroup
Python	aws_cdk.aws_redshift_alpha.ClusterParameterGroup
TypeScript (source)	@aws-cdk/aws-redshift-alpha » ClusterParameterGroup

Implements IConstruct, IDependable, IResource, IClusterParameterGroup

A cluster parameter group.

Example

import { ClusterParameterGroup } from '@aws-cdk/aws-redshift-alpha';

const params = new ClusterParameterGroup(this, 'Params', {
  description: 'desc',
  parameters: {
    require_ssl: 'true',
  },
});

params.addParameter('enable_user_activity_logging', 'true');

Initializer

new ClusterParameterGroup(scope: Construct, id: string, props: ClusterParameterGroupProps)

Parameters

• scope Construct
• id string
• props ClusterParameterGroupProps

Construct Props

Name	Type	Description
parameters🔹	{ [string]: string }	The parameters in this parameter group.
description?🔹	string	Description for this parameter group.

---

parameters🔹

Type: { [string]: string }

The parameters in this parameter group.

---

description?🔹

Type: string (optional, default: a CDK generated description)

Description for this parameter group.

Properties

Name	Type	Description
clusterParameterGroupName🔹	string	The name of the parameter group.
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	Node	The tree node.
parameters🔹	{ [string]: string }	The parameters in the parameter group.
stack🔹	Stack	The stack in which this resource is defined.

---

clusterParameterGroupName🔹

Type: string

The name of the parameter group.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node🔹

Type: Node

The tree node.

---

parameters🔹

Type: { [string]: string }

The parameters in the parameter group.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
addParameter(name, value)🔹	Adds a parameter to the parameter group.
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
toString()🔹	Returns a string representation of this construct.
static fromClusterParameterGroupName(scope, id, clusterParameterGroupName)🔹	Imports a parameter group.

---

addParameter(name, value)🔹

public addParameter(name: string, value: string): void

Parameters

• name string — the parameter name.
• value string — the parameter name.

Adds a parameter to the parameter group.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromClusterParameterGroupName(scope, id, clusterParameterGroupName)🔹

public static fromClusterParameterGroupName(scope: Construct, id: string, clusterParameterGroupName: string): IClusterParameterGroup

Parameters

• scope Construct
• id string
• clusterParameterGroupName string

Returns

• IClusterParameterGroup

Imports a parameter group.