inital implementation

aws · mergify · Feb 17, 2023 · Sep 13, 2022 · Sep 14, 2022 · Sep 15, 2022
commit 8b8798c2ae69ed098d92cd8aabf020d5f235eed4
diff --git a/packages/@aws-cdk/aws-redshift/lib/cluster.ts b/packages/@aws-cdk/aws-redshift/lib/cluster.ts
@@ -1,16 +1,18 @@
+import * as path from 'path';
 import * as ec2 from '@aws-cdk/aws-ec2';
 import * as iam from '@aws-cdk/aws-iam';
 import * as kms from '@aws-cdk/aws-kms';
+import * as lambda from '@aws-cdk/aws-lambda';
 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, RemovalPolicy, Resource, SecretValue, Token, CustomResource, Stack, ArnFormat } from '@aws-cdk/core';
+import * as cr from '@aws-cdk/custom-resources';
 import { Construct } from 'constructs';
 import { DatabaseSecret } from './database-secret';
 import { Endpoint } from './endpoint';
 import { ClusterParameterGroup, IClusterParameterGroup } from './parameter-group';
 import { CfnCluster } from './redshift.generated';
 import { ClusterSubnetGroup, IClusterSubnetGroup } from './subnet-group';
-
 /**
  * Possible Node Types to use in the cluster
  * used for defining {@link ClusterProps.nodeType}.
@@ -354,6 +356,12 @@ export interface ClusterProps {
    * @default - No Elastic IP
    */
   readonly elasticIp?: string
+
+  /**
+   * If this flag is set, the cluster will be rebooted when changes to the cluster's parameter group that require a restart to apply.
+   * @default false
+   */
+  readonly rebootForParameterChanges?: boolean
 }
 
 /**
@@ -452,6 +460,11 @@ export class Cluster extends ClusterBase {
    */
   protected parameterGroup?: IClusterParameterGroup;
 
+  /**
+   * Whether the cluster will be rebooted when changes to the cluster's parameter group that require a restart to apply.
+   */
+  protected rebootForParameterChangesEnabled?: boolean;
+
   constructor(scope: Construct, id: string, props: ClusterProps) {
     super(scope, id);
 
@@ -565,6 +578,9 @@ export class Cluster extends ClusterBase {
 
     const defaultPort = ec2.Port.tcp(this.clusterEndpoint.port);
     this.connections = new ec2.Connections({ securityGroups, defaultPort });
+    if (props.rebootForParameterChanges) {
+      this.enableRebootForParameterChanges();
+    }
   }
 
   /**
@@ -652,4 +668,54 @@ export class Cluster extends ClusterBase {
       throw new Error('Cannot add a parameter to an imported parameter group.');
     }
   }
+
+  /**
+   * Enables automatic cluster rebooting when changes to the cluster's parameter group require a restart to apply.
+   */
+  public enableRebootForParameterChanges(): void {
+    if (!this.parameterGroup) {
+      throw new Error('Cannot enable reboot for parameter changes when there is no associated ClusterParameterGroup.');
+    }
+    if (!(this.parameterGroup instanceof ClusterParameterGroup)) {
+      throw new Error('Cannot enable reboot for parameter changes when using an imported parameter group.');
+    }
+    if (!this.rebootForParameterChangesEnabled) {
+      this.rebootForParameterChangesEnabled = true;
+      const rebootFunction = new lambda.SingletonFunction(this, 'RedshiftClusterRebooterFunction', {
+        uuid: '511e207f-13df-4b8b-b632-c32b30b65ac2',
+        runtime: lambda.Runtime.NODEJS_16_X,
+        code: lambda.Code.fromAsset(path.join(__dirname, 'cluster-parameter-change-reboot-handler')),
+        handler: 'index.handler',
+        timeout: Duration.seconds(900),
+      });
+      rebootFunction.addToRolePolicy(new iam.PolicyStatement({
+        actions: ['redshift:DescribeClusters'],
+        resources: ['*'],
+      }));
+      rebootFunction.addToRolePolicy(new iam.PolicyStatement({
+        actions: ['reshift:RebootCluster'],
+        resources: [
+          Stack.of(this).formatArn({
+            service: 'redshift',
+            resource: 'cluster',
+            resourceName: this.clusterName,
+            arnFormat: ArnFormat.COLON_RESOURCE_NAME,
+          }),
+        ],
+      }));
+      const provider = new cr.Provider(this, 'ResourceProvider', {
+        onEventHandler: rebootFunction,
+      });
+      const customResource = new CustomResource(this, 'RedshiftClusterRebooterCustomResource', {
+        resourceType: 'Custom::RedshiftClusterRebooter',
+        serviceToken: provider.serviceToken,
+        properties: {
+          ClusterId: this.cluster.getAtt('id'),
+          ParameterGroupName: this.parameterGroup.clusterParameterGroupName,
+          ParametersString: JSON.stringify(this.parameterGroup.parameters),
+        },
+      });
+      customResource.node.addDependency(this, this.parameterGroup);
+    }
+  }
 }
diff --git a/packages/@aws-cdk/aws-redshift/test/cluster.test.ts b/packages/@aws-cdk/aws-redshift/test/cluster.test.ts
@@ -613,6 +613,80 @@ test('elastic ip address', () => {
   });
 });
 
+describe('reboot for Parameter Changes', () => {
+  test('cluster without parameter group', () => {
+    // Given
+    const cluster = new Cluster(stack, 'Redshift', {
+      masterUser: {
+        masterUsername: 'admin',
+      },
+      vpc,
+    });
+
+    // WHEN
+    expect(() => cluster.enableRebootForParameterChanges())
+      // THEN
+      .toThrowError(/Cannot enable reboot for parameter changes/);
+  });
+
+  test('cluster with imported parameter group', () => {
+    // Given
+    const cluster = new Cluster(stack, 'Redshift', {
+      masterUser: {
+        masterUsername: 'admin',
+      },
+      vpc,
+    });
+    cluster.addToParameterGroup('foo', 'bar');
+
+    const cluster2 = new Cluster(stack, 'Redshift2', {
+      masterUser: {
+        masterUsername: 'admin',
+      },
+      vpc,
+    });
+    cluster2.addToParameterGroup('foo', 'bar');
+
+    // WHEN
+    cluster.enableRebootForParameterChanges();
+    cluster2.enableRebootForParameterChanges();
+
+    //THEN
+    const template = Template.fromStack(stack);
+    template.resourceCountIs('Custom::RedshiftClusterRebooter', 2);
+    template.templateMatches({
+      Resources: {
+        SingletonLambda511e207f13df4b8bb632c32b30b65ac281740AC5: {
+          Type: 'AWS::Lambda::Function',
+          Properties: {
+            Handler: 'index.handler',
+            Runtime: 'nodejs16.x',
+            Timeout: 900,
+          },
+        },
+      },
+    });
+  });
+
+
+  test('cluster with parameter group', () => {
+    // Given
+    const cluster = new Cluster(stack, 'Redshift', {
+      masterUser: {
+        masterUsername: 'admin',
+      },
+      vpc,
+      parameterGroup: ClusterParameterGroup.fromClusterParameterGroupName(stack, 'foo', 'bar'),
+    });
+
+    // WHEN
+    expect(() => cluster.enableRebootForParameterChanges())
+      // THEN
+      .toThrowError(/Cannot enable reboot for parameter changes/);
+  });
+
+});
+
 function testStack() {
   const newTestStack = new cdk.Stack(undefined, undefined, { env: { account: '12345', region: 'us-test-1' } });
   newTestStack.node.setContext('availability-zones:12345:us-test-1', ['us-test-1a', 'us-test-1b']);