feat(redshift-alpha): directly add parameters to a parameter group or indirectly through a cluster

packages/@aws-cdk/aws-redshift/README.md

@@ -300,6 +300,37 @@ cluster.addRotationMultiUser('MultiUserRotation', {
 });
 ```
 
+## Adding Parameters
+
+You can add a parameter to a parameter group with`ClusterParameterGroup.addParameter()`.
+
+```ts
+const params = new ClusterParameterGroup(stack, 'Params', {
+  description: 'desc',
+  parameters: {
+    require_ssl: 'true',
+  },
+});
+
+params.addParameter('enable_user_activity_logging', 'true');
+```
+
+Additionally, you can add a parameter to the cluster's associated parameter group with `Cluster.addToParameterGroup()`. If the cluster does not have an associated parameter group, a new parameter group is created.
+
+```ts
+declare const vpc: ec2.Vpc;
+
+const cluster = new Cluster(this, 'Cluster', {
+  masterUser: {
+    masterUsername: 'admin',
+    masterPassword: cdk.SecretValue.unsafePlainText('tooshort'),
+  },
+  vpc,
+});
+
+cluster.addToParameterGroup('enable_user_activity_logging', 'true');
+```
+
 ## Elastic IP
 
 If you configure your cluster to be publicly accessible, you can optionally select an *elastic IP address* to use for the external IP address. An elastic IP address is a static IP address that is associated with your AWS account. You can use an elastic IP address to connect to your cluster from outside the VPC. An elastic IP address gives you the ability to change your underlying configuration without affecting the IP address that clients use to connect to your cluster. This approach can be helpful for situations such as recovery after a failure.

packages/@aws-cdk/aws-redshift/lib/cluster.ts

@@ -3,11 +3,11 @@ import * as iam from '@aws-cdk/aws-iam';
 import * as kms from '@aws-cdk/aws-kms';
 import * as s3 from '@aws-cdk/aws-s3';
 import * as secretsmanager from '@aws-cdk/aws-secretsmanager';
-import { Duration, IResource, RemovalPolicy, Resource, SecretValue, Token } from '@aws-cdk/core';
+import { Duration, IResource, Names, RemovalPolicy, Resource, SecretValue, Token } from '@aws-cdk/core';
 import { Construct } from 'constructs';
 import { DatabaseSecret } from './database-secret';
 import { Endpoint } from './endpoint';
-import { IClusterParameterGroup } from './parameter-group';
+import { ClusterParameterGroup, IClusterParameterGroup } from './parameter-group';
 import { CfnCluster } from './redshift.generated';
 import { ClusterSubnetGroup, IClusterSubnetGroup } from './subnet-group';
 
@@ -360,6 +360,7 @@ export interface ClusterProps {
  * A new or imported clustered database.
  */
 abstract class ClusterBase extends Resource implements ICluster {
+
   /**
    * Name of the cluster
    */
@@ -405,7 +406,6 @@ export class Cluster extends ClusterBase {
       public readonly instanceIdentifiers: string[] = [];
       public readonly clusterEndpoint = new Endpoint(attrs.clusterEndpointAddress, attrs.clusterEndpointPort);
     }
-
     return new Import(scope, id);
   }
 
@@ -442,13 +442,24 @@ export class Cluster extends ClusterBase {
    */
   private readonly vpcSubnets?: ec2.SubnetSelection;
 
+  /**
+   * The underlying CfnCluster
+   */
+  private readonly cluster: CfnCluster;
+
+  /**
+   * The cluster's parameter group
+   */
+  protected parameterGroup?: IClusterParameterGroup;
+
   constructor(scope: Construct, id: string, props: ClusterProps) {
     super(scope, id);
 
     this.vpc = props.vpc;
     this.vpcSubnets = props.vpcSubnets ?? {
       subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS,
     };
+    this.parameterGroup = props.parameterGroup;
 
     const removalPolicy = props.removalPolicy ?? RemovalPolicy.RETAIN;
 
@@ -509,7 +520,7 @@ export class Cluster extends ClusterBase {
       );
     }
 
-    const cluster = new CfnCluster(this, 'Resource', {
+    this.cluster = new CfnCluster(this, 'Resource', {
       // Basic
       allowVersionUpgrade: true,
       automatedSnapshotRetentionPeriod: 1,
@@ -538,15 +549,15 @@ export class Cluster extends ClusterBase {
       elasticIp: props.elasticIp,
     });
 
-    cluster.applyRemovalPolicy(removalPolicy, {
+    this.cluster.applyRemovalPolicy(removalPolicy, {
       applyToUpdateReplacePolicy: true,
     });
 
-    this.clusterName = cluster.ref;
+    this.clusterName = this.cluster.ref;
 
     // create a number token that represents the port of the cluster
-    const portAttribute = Token.asNumber(cluster.attrEndpointPort);
-    this.clusterEndpoint = new Endpoint(cluster.attrEndpointAddress, portAttribute);
+    const portAttribute = Token.asNumber(this.cluster.attrEndpointPort);
+    this.clusterEndpoint = new Endpoint(this.cluster.attrEndpointAddress, portAttribute);
 
     if (secret) {
       this.secret = secret.attach(this);
@@ -619,4 +630,26 @@ export class Cluster extends ClusterBase {
       return nodeCount;
     }
   }
+
+  /**
+   * Adds a parameter to the Clusters' parameter group
+   *
+   * @param name the parameter name
+   * @param value the parameter name
+   */
+  public addToParameterGroup(name: string, value: string): void {
+    if (!this.parameterGroup) {
+      const param: { [name: string]: string } = {};
+      param[name] = value;
+      this.parameterGroup = new ClusterParameterGroup(this, 'ParameterGroup', {
+        description: `Parameter Group for the ${this.cluster.clusterIdentifier ?? Names.uniqueResourceName(this, {})} Redshift cluster`,
+        parameters: param,
+      });
+      this.cluster.clusterParameterGroupName = this.parameterGroup.clusterParameterGroupName;
+    } else if (this.parameterGroup instanceof ClusterParameterGroup) {
+      this.parameterGroup.addParameter(name, value);
+    } else {
+      throw new Error('Cannot add a parameter to an imported parameter group.');
+    }
+  }
 }

packages/@aws-cdk/aws-redshift/lib/parameter-group.ts

@@ -18,6 +18,7 @@ export interface IClusterParameterGroup extends IResource {
  * A new cluster or instance parameter group
  */
 abstract class ClusterParameterGroupBase extends Resource implements IClusterParameterGroup {
+
   /**
    * The name of the parameter group
    */
@@ -62,17 +63,46 @@ export class ClusterParameterGroup extends ClusterParameterGroupBase {
    */
   public readonly clusterParameterGroupName: string;
 
+  /**
+   * The parameters in the parameter group
+  */
+  readonly parameters: { [name: string]: string };
+
+  /**
+   * The underlying CfnClusterParameterGroup
+  */
+  private readonly resource: CfnClusterParameterGroup;
+
   constructor(scope: Construct, id: string, props: ClusterParameterGroupProps) {
     super(scope, id);
-
-    const resource = new CfnClusterParameterGroup(this, 'Resource', {
+    this.parameters = props.parameters;
+    this.resource = new CfnClusterParameterGroup(this, 'Resource', {
       description: props.description || 'Cluster parameter group for family redshift-1.0',
       parameterGroupFamily: 'redshift-1.0',
-      parameters: Object.entries(props.parameters).map(([name, value]) => {
-        return { parameterName: name, parameterValue: value };
-      }),
+      parameters: this.parseParameters(),
     });
 
-    this.clusterParameterGroupName = resource.ref;
+    this.clusterParameterGroupName = this.resource.ref;
+  }
+  private parseParameters(): any {
+    return Object.entries(this.parameters).map(([name, value]) => {
+      return { parameterName: name, parameterValue: value };
+    });
+  }
+
+  /**
+   * Adds a parameter to the parameter group
+   *
+   * @param name the parameter name
+   * @param value the parameter name
+   */
+  public addParameter(name: string, value: string): void {
+    const existingValue = Object.entries(this.parameters).find(([key, _]) => key === name)?.[1];
+    if (existingValue === undefined) {
+      this.parameters[name] = value;
+      this.resource.parameters = this.parseParameters();
+    } else if (existingValue !== value) {
+      throw new Error(`The parameter group already contains the parameter "${name}", but with a different value (Given: ${value}, Existing: ${existingValue}).`);
+    }
   }
 }

packages/@aws-cdk/aws-redshift/test/cluster.test.ts

@@ -253,27 +253,116 @@ test('create an encrypted cluster with custom KMS key', () => {
     },
   });
 });
+describe('parameter group', () => {
+  test('cluster instantiated with parameter group', () => {
+    // WHEN
+    const group = new ClusterParameterGroup(stack, 'Params', {
+      description: 'bye',
+      parameters: {
+        param: 'value',
+      },
+    });
+
+    new Cluster(stack, 'Redshift', {
+      masterUser: {
+        masterUsername: 'admin',
+      },
+      vpc,
+      parameterGroup: group,
+    });
+
+    // THEN
+    Template.fromStack(stack).hasResourceProperties('AWS::Redshift::Cluster', {
+      ClusterParameterGroupName: { Ref: 'ParamsA8366201' },
+    });
 
-test('cluster with parameter group', () => {
-  // WHEN
-  const group = new ClusterParameterGroup(stack, 'Params', {
-    description: 'bye',
-    parameters: {
-      param: 'value',
-    },
   });
 
-  new Cluster(stack, 'Redshift', {
-    masterUser: {
-      masterUsername: 'admin',
-    },
-    vpc,
-    parameterGroup: group,
+  test('Adding to the cluster parameter group on a cluster not instantiated with a parameter group', () => {
+
+    // WHEN
+    const cluster = new Cluster(stack, 'Redshift', {
+      clusterName: 'foobar',
+      masterUser: {
+        masterUsername: 'admin',
+      },
+      vpc,
+    });
+
+    cluster.addToParameterGroup('foo', 'bar');
+
+    const template = Template.fromStack(stack);
+    template.hasResourceProperties('AWS::Redshift::Cluster', {
+      ClusterParameterGroupName: { Ref: Match.anyValue() },
+    });
+
+    template.hasResourceProperties('AWS::Redshift::ClusterParameterGroup', {
+      Description: 'Parameter Group for the foobar Redshift cluster',
+      ParameterGroupFamily: 'redshift-1.0',
+      Parameters: [
+        {
+          ParameterName: 'foo',
+          ParameterValue: 'bar',
+        },
+      ],
+    });
   });
 
-  // THEN
-  Template.fromStack(stack).hasResourceProperties('AWS::Redshift::Cluster', {
-    ClusterParameterGroupName: { Ref: 'ParamsA8366201' },
+  test('Adding to the cluster parameter group on a cluster instantiated with a parameter group', () => {
+
+    // WHEN
+    const group = new ClusterParameterGroup(stack, 'Params', {
+      description: 'lorem ipsum',
+      parameters: {
+        param: 'value',
+      },
+    });
+
+    const cluster = new Cluster(stack, 'Redshift', {
+      masterUser: {
+        masterUsername: 'admin',
+      },
+      vpc,
+      parameterGroup: group,
+    });
+    cluster.addToParameterGroup('foo', 'bar');
+
+    const template = Template.fromStack(stack);
+    template.hasResourceProperties('AWS::Redshift::Cluster', {
+      ClusterParameterGroupName: { Ref: Match.anyValue() },
+    });
+
+    template.hasResourceProperties('AWS::Redshift::ClusterParameterGroup', {
+      Description: 'lorem ipsum',
+      ParameterGroupFamily: 'redshift-1.0',
+      Parameters: [
+        {
+          ParameterName: 'param',
+          ParameterValue: 'value',
+        },
+        {
+          ParameterName: 'foo',
+          ParameterValue: 'bar',
+        },
+      ],
+    });
+  });
+
+  test('Adding a parameter to an IClusterParameterGroup', () => {
+    // GIVEN
+    const cluster = new Cluster(stack, 'Redshift', {
+      clusterName: 'foobar',
+      parameterGroup: ClusterParameterGroup.fromClusterParameterGroupName(stack, 'Params', 'foo'),
+      masterUser: {
+        masterUsername: 'admin',
+      },
+      vpc,
+    });
+
+    // WHEN
+    expect(() => cluster.addToParameterGroup('param', 'value2'))
+      // THEN
+      .toThrowError('Cannot add a parameter to an imported parameter group');
   });
 
 });
@@ -374,7 +463,7 @@ test('throws validation error when trying to set encryptionKey without enabling
 
   // THEN
   expect(() => {
-    new Cluster(stack, 'Redshift', props );
+    new Cluster(stack, 'Redshift', props);
   }).toThrowError();
 
 });

packages/@aws-cdk/aws-redshift/test/database.integ.snapshot/aws-cdk-redshift-cluster-database.template.json

@@ -565,6 +565,9 @@
     "NodeType": "dc2.large",
     "AllowVersionUpgrade": true,
     "AutomatedSnapshotRetentionPeriod": 1,
+    "ClusterParameterGroupName": {
+     "Ref": "ClusterParameterGroup879806FD"
+    },
     "ClusterSubnetGroupName": {
      "Ref": "ClusterSubnetsDCFA5CB7"
     },
@@ -586,6 +589,21 @@
    "UpdateReplacePolicy": "Delete",
    "DeletionPolicy": "Delete"
   },
+  "ClusterParameterGroup879806FD": {
+   "Type": "AWS::Redshift::ClusterParameterGroup",
+   "Properties": {
+    "Description": "Parameter Group for the awscdkredshiftclusterdatabaseCluster97CBCDB4 Redshift cluster",
+    "ParameterGroupFamily": "redshift-1.0",
+    "Parameters": [
+     {
+      "ParameterName": "enable_user_activity_logging",
+      "ParameterValue": "true"
+     }
+    ]
+   },
+   "UpdateReplacePolicy": "Delete",
+   "DeletionPolicy": "Delete"
+  },
   "UserSecretE2C04A69": {
    "Type": "AWS::SecretsManager::Secret",
    "Properties": {

packages/@aws-cdk/aws-redshift/test/database.integ.snapshot/manifest.json

@@ -213,6 +213,12 @@
             "data": "ClusterEB0386A7"
           }
         ],
+        "/aws-cdk-redshift-cluster-database/Cluster/ParameterGroup/Resource": [
+          {
+            "type": "aws:cdk:logicalId",
+            "data": "ClusterParameterGroup879806FD"
+          }
+        ],
         "/aws-cdk-redshift-cluster-database/User/Secret/Resource": [
           {
             "type": "aws:cdk:logicalId",