Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: support the 'Description' resource attribute #10522

Merged
merged 4 commits into from
Sep 26, 2020
Merged

feat: support the 'Description' resource attribute #10522

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
46d3b08
feat: support the 'Description' resource attribute
skinny85 Sep 25, 2020
901eff4
Apply Shiv's suggestions from the code review
skinny85 Sep 25, 2020
3fa5e58
Missed a trailing comma
skinny85 Sep 25, 2020
72efdd1
Merge branch 'master' into feat/description-resource-attribute
mergify[bot] Sep 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/@aws-cdk/cloudformation-include/lib/cfn-include.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)) {
Expand Down
1 change: 1 addition & 0 deletions .../@aws-cdk/cloudformation-include/test/test-templates/custom-resource-with-attributes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
},
"CustomResource": {
"Type": "AWS::CloudFormation::CustomResource",
"Description": "some random custom resource",
"Properties": {
"ServiceToken": "CustomValue",
"CustomFuncProp": {
Expand Down
1 change: 1 addition & 0 deletions packages/@aws-cdk/core/lib/cfn-parse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 9 additions & 0 deletions packages/@aws-cdk/core/lib/cfn-resource.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 => {
Expand Down Expand Up @@ -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.
Expand Down