feat(cloudformation): Add removalPolicy on CustomResource

packages/@aws-cdk/aws-cloudformation/lib/custom-resource.ts

@@ -1,6 +1,6 @@
 import lambda = require('@aws-cdk/aws-lambda');
 import sns = require('@aws-cdk/aws-sns');
-import { CfnResource, Construct, Resource } from '@aws-cdk/cdk';
+import { applyRemovalPolicy, CfnResource, Construct, RemovalPolicy, Resource } from '@aws-cdk/cdk';
 import { CfnCustomResource } from './cloudformation.generated';
 
 /**
@@ -21,9 +21,7 @@ export class CustomResourceProvider {
    */
   public static topic(topic: sns.ITopic) { return new CustomResourceProvider(topic.topicArn); }
 
-  private constructor(public readonly serviceToken: string) {
-
-  }
+  private constructor(public readonly serviceToken: string) {}
 }
 
 /**
@@ -67,6 +65,13 @@ export interface CustomResourceProps {
    * @default - AWS::CloudFormation::CustomResource
    */
   readonly resourceType?: string;
+
+  /**
+   * The policy to apply when this resource is removed from the application.
+   *
+   * @default cdk.RemovalPolicy.Destroy
+   */
+  readonly removalPolicy?: RemovalPolicy;
 }
 
 /**
@@ -91,6 +96,8 @@ export class CustomResource extends Resource {
         ...uppercaseProperties(props.properties || {})
       }
     });
+
+    applyRemovalPolicy(this.resource, props.removalPolicy);
   }
 
   public getAtt(attributeName: string) {

packages/@aws-cdk/aws-cloudformation/test/test.resource.ts

@@ -1,16 +1,83 @@
-import { expect, haveResource } from '@aws-cdk/assert';
+import { expect, haveResource, ResourcePart } from '@aws-cdk/assert';
 import lambda = require('@aws-cdk/aws-lambda');
 import sns = require('@aws-cdk/aws-sns');
 import cdk = require('@aws-cdk/cdk');
-import { Test } from 'nodeunit';
+import { Test, testCase } from 'nodeunit';
 import { CustomResource, CustomResourceProvider } from '../lib';
 
 // tslint:disable:object-literal-key-quotes
 
-export = {
+export = testCase({
+  'custom resources honor removalPolicy': {
+    'unspecified (aka .Destroy)'(test: Test) {
+      // GIVEN
+      const app = new cdk.App();
+      const stack = new cdk.Stack(app, 'Test');
+
+      // WHEN
+      new TestCustomResource(stack, 'Custom');
+
+      // THEN
+      expect(stack).to(haveResource('AWS::CloudFormation::CustomResource', {}, ResourcePart.CompleteDefinition));
+      test.equal(app.synth().tryGetArtifact(stack.name)!.findMetadataByType('aws:cdk:protected').length, 0);
+
+      test.done();
+    },
+
+    '.Destroy'(test: Test) {
+      // GIVEN
+      const app = new cdk.App();
+      const stack = new cdk.Stack(app, 'Test');
+
+      // WHEN
+      new TestCustomResource(stack, 'Custom', { removalPolicy: cdk.RemovalPolicy.Destroy });
+
+      // THEN
+      expect(stack).to(haveResource('AWS::CloudFormation::CustomResource', {}, ResourcePart.CompleteDefinition));
+      test.equal(app.synth().tryGetArtifact(stack.name)!.findMetadataByType('aws:cdk:protected').length, 0);
+
+      test.done();
+    },
+
+    '.Orphan'(test: Test) {
+      // GIVEN
+      const app = new cdk.App();
+      const stack = new cdk.Stack(app, 'Test');
+
+      // WHEN
+      new TestCustomResource(stack, 'Custom', {  removalPolicy: cdk.RemovalPolicy.Orphan });
+
+      // THEN
+      expect(stack).to(haveResource('AWS::CloudFormation::CustomResource', {
+        DeletionPolicy: 'Retain',
+      }, ResourcePart.CompleteDefinition));
+      test.equal(app.synth().tryGetArtifact(stack.name)!.findMetadataByType('aws:cdk:protected').length, 0);
+
+      test.done();
+    },
+
+    '.Forbid'(test: Test) {
+      // GIVEN
+      const app = new cdk.App();
+      const stack = new cdk.Stack(app, 'Test');
+
+      // WHEN
+      new TestCustomResource(stack, 'Custom', {  removalPolicy: cdk.RemovalPolicy.Forbid });
+
+      // THEN
+      expect(stack).to(haveResource('AWS::CloudFormation::CustomResource', {
+        DeletionPolicy: 'Retain',
+      }, ResourcePart.CompleteDefinition));
+      test.ok(app.synth().tryGetArtifact(stack.name)!.findMetadataByType('aws:cdk:protected')[0].data);
+
+      test.done();
+    },
+  },
+
   'custom resource is added twice, lambda is added once'(test: Test) {
     // GIVEN
-    const stack = new cdk.Stack();
+    const app = new cdk.App();
+    const stack = new cdk.Stack(app, 'Test');
 
     // WHEN
     new TestCustomResource(stack, 'Custom1');
@@ -88,7 +155,8 @@ export = {
   },
 
   'custom resources can specify a resource type that starts with Custom::'(test: Test) {
-    const stack = new cdk.Stack();
+    const app = new cdk.App();
+    const stack = new cdk.Stack(app, 'Test');
     new CustomResource(stack, 'MyCustomResource', {
       resourceType: 'Custom::MyCustomResourceType',
       provider: CustomResourceProvider.topic(new sns.Topic(stack, 'Provider'))
@@ -99,7 +167,8 @@ export = {
 
   'fails if custom resource type is invalid': {
     'does not start with "Custom::"'(test: Test) {
-      const stack = new cdk.Stack();
+      const app = new cdk.App();
+      const stack = new cdk.Stack(app, 'Test');
 
       test.throws(() => {
         new CustomResource(stack, 'MyCustomResource', {
@@ -112,7 +181,8 @@ export = {
     },
 
     'has invalid characters'(test: Test) {
-      const stack = new cdk.Stack();
+      const app = new cdk.App();
+      const stack = new cdk.Stack(app, 'Test');
 
       test.throws(() => {
         new CustomResource(stack, 'MyCustomResource', {
@@ -125,7 +195,8 @@ export = {
     },
 
     'is longer than 60 characters'(test: Test) {
-      const stack = new cdk.Stack();
+      const app = new cdk.App();
+      const stack = new cdk.Stack(app, 'Test');
 
       test.throws(() => {
         new CustomResource(stack, 'MyCustomResource', {
@@ -138,10 +209,10 @@ export = {
     },
 
   },
-};
+});
 
 class TestCustomResource extends cdk.Construct {
-  constructor(scope: cdk.Construct, id: string) {
+  constructor(scope: cdk.Construct, id: string, opts: { removalPolicy?: cdk.RemovalPolicy } = {}) {
     super(scope, id);
 
     const singletonLambda = new lambda.SingletonFunction(this, 'Lambda', {
@@ -153,7 +224,8 @@ class TestCustomResource extends cdk.Construct {
     });
 
     new CustomResource(this, 'Resource', {
-      provider: CustomResourceProvider.lambda(singletonLambda)
+      ...opts,
+      provider: CustomResourceProvider.lambda(singletonLambda),
     });
   }
 }