From d68ce2f4b42099064342baeb4b494810aa362e27 Mon Sep 17 00:00:00 2001
From: Adam Ruka <adamruka@amazon.com>
Date: Fri, 25 Sep 2020 17:41:55 -0700
Subject: [PATCH] feat: support the 'Description' resource attribute (#10522)

One more resource attribute that we missed,
and that is needed for cfn-include to be able to handle ingesting all templates.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
---
 .../@aws-cdk/cloudformation-include/lib/cfn-include.ts   | 4 ++--
 .../test-templates/custom-resource-with-attributes.json  | 1 +
 packages/@aws-cdk/core/lib/cfn-parse.ts                  | 1 +
 packages/@aws-cdk/core/lib/cfn-resource.ts               | 9 +++++++++
 4 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/packages/@aws-cdk/cloudformation-include/lib/cfn-include.ts b/packages/@aws-cdk/cloudformation-include/lib/cfn-include.ts
index aad5c653c3693..becb5666c3653 100644
--- a/packages/@aws-cdk/cloudformation-include/lib/cfn-include.ts
+++ b/packages/@aws-cdk/cloudformation-include/lib/cfn-include.ts
@@ -589,8 +589,8 @@ export class CfnInclude extends core.CfnElement {
 
     // fail early for resource attributes we don't support yet
     const knownAttributes = [
-      'Type', 'Properties', 'Condition', 'DependsOn', 'Metadata', 'Version',
-      'CreationPolicy', 'UpdatePolicy', 'DeletionPolicy', 'UpdateReplacePolicy',
+      'Condition', 'DependsOn', 'Description', 'Metadata', 'Properties', 'Type', 'Version',
+      'CreationPolicy', 'DeletionPolicy', 'UpdatePolicy', 'UpdateReplacePolicy',
     ];
     for (const attribute of Object.keys(resourceAttributes)) {
       if (!knownAttributes.includes(attribute)) {
diff --git a/packages/@aws-cdk/cloudformation-include/test/test-templates/custom-resource-with-attributes.json b/packages/@aws-cdk/cloudformation-include/test/test-templates/custom-resource-with-attributes.json
index c490a16515944..b1dcf4d219bf1 100644
--- a/packages/@aws-cdk/cloudformation-include/test/test-templates/custom-resource-with-attributes.json
+++ b/packages/@aws-cdk/cloudformation-include/test/test-templates/custom-resource-with-attributes.json
@@ -28,6 +28,7 @@
     },
     "CustomResource": {
       "Type": "AWS::CloudFormation::CustomResource",
+      "Description": "some random custom resource",
       "Properties": {
         "ServiceToken": "CustomValue",
         "CustomFuncProp": {
diff --git a/packages/@aws-cdk/core/lib/cfn-parse.ts b/packages/@aws-cdk/core/lib/cfn-parse.ts
index b226f9e1472cb..886a9228b3d0a 100644
--- a/packages/@aws-cdk/core/lib/cfn-parse.ts
+++ b/packages/@aws-cdk/core/lib/cfn-parse.ts
@@ -285,6 +285,7 @@ export class CfnParser {
     cfnOptions.deletionPolicy = this.parseDeletionPolicy(resourceAttributes.DeletionPolicy);
     cfnOptions.updateReplacePolicy = this.parseDeletionPolicy(resourceAttributes.UpdateReplacePolicy);
     cfnOptions.version = this.parseValue(resourceAttributes.Version);
+    cfnOptions.description = this.parseValue(resourceAttributes.Description);
     cfnOptions.metadata = this.parseValue(resourceAttributes.Metadata);
 
     // handle Condition
diff --git a/packages/@aws-cdk/core/lib/cfn-resource.ts b/packages/@aws-cdk/core/lib/cfn-resource.ts
index fcb1c95eaf5bb..f5049bdcd2326 100644
--- a/packages/@aws-cdk/core/lib/cfn-resource.ts
+++ b/packages/@aws-cdk/core/lib/cfn-resource.ts
@@ -301,6 +301,7 @@ export class CfnResource extends CfnRefElement {
             UpdateReplacePolicy: capitalizePropertyNames(this, this.cfnOptions.updateReplacePolicy),
             DeletionPolicy: capitalizePropertyNames(this, this.cfnOptions.deletionPolicy),
             Version: this.cfnOptions.version,
+            Description: this.cfnOptions.description,
             Metadata: ignoreEmpty(this.cfnOptions.metadata),
             Condition: this.cfnOptions.condition && this.cfnOptions.condition.logicalId,
           }, props => {
@@ -438,6 +439,14 @@ export interface ICfnResourceOptions {
    */
   version?: string;
 
+  /**
+   * The description of this resource.
+   * Used for informational purposes only, is not processed in any way
+   * (and stays with the CloudFormation template, is not passed to the underlying resource,
+   * even if it does have a 'description' property).
+   */
+  description?: string;
+
   /**
    * Metadata associated with the CloudFormation resource. This is not the same as the construct metadata which can be added
    * using construct.addMetadata(), but would not appear in the CloudFormation template automatically.