Skip to content

Commit 8651bbe

Browse files
authored
feat(apigatewayv2): add description property for stage (#30820)
### Issue # (if applicable) ### Reason for this change The `description` property existed in the L1 construct but was not present in the L2 construct ### Description of changes Add the `description` property for `HttpStage` and `WebSocketStage`, which was missing in the L2 construct. ### Description of how you validated changes I Added both unit test and integration tests. ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent 153a698 commit 8651bbe

File tree

20 files changed

+158
-70
lines changed

20 files changed

+158
-70
lines changed

packages/@aws-cdk-testing/framework-integ/test/aws-apigatewayv2/test/http/integ.stage.js.snapshot/aws-cdk-aws-apigatewayv2-http-stage.assets.json

+3-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@aws-cdk-testing/framework-integ/test/aws-apigatewayv2/test/http/integ.stage.js.snapshot/aws-cdk-aws-apigatewayv2-http-stage.template.json

+3-2
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,12 @@
1313
"ApiId": {
1414
"Ref": "HttpApiF5A9A8A7"
1515
},
16-
"StageName": "$default",
1716
"DefaultRouteSettings": {
1817
"ThrottlingBurstLimit": 1000,
1918
"ThrottlingRateLimit": 1000
20-
}
19+
},
20+
"Description": "My Stage",
21+
"StageName": "$default"
2122
}
2223
}
2324
},

packages/@aws-cdk-testing/framework-integ/test/aws-apigatewayv2/test/http/integ.stage.js.snapshot/cdk.out

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@aws-cdk-testing/framework-integ/test/aws-apigatewayv2/test/http/integ.stage.js.snapshot/integ.json

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@aws-cdk-testing/framework-integ/test/aws-apigatewayv2/test/http/integ.stage.js.snapshot/manifest.json

+9-8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@aws-cdk-testing/framework-integ/test/aws-apigatewayv2/test/http/integ.stage.js.snapshot/tree.json

+37-20
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@aws-cdk-testing/framework-integ/test/aws-apigatewayv2/test/http/integ.stage.ts

+1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ new apigw.HttpStage(stack, 'HttpStageWithProperties', {
1212
rateLimit: 1000,
1313
burstLimit: 1000,
1414
},
15+
description: 'My Stage',
1516
});
1617

1718
app.synth();

packages/@aws-cdk-testing/framework-integ/test/aws-apigatewayv2/test/websocket/integ.stage.js.snapshot/aws-cdk-aws-apigatewayv2-websocket-stage.assets.json

+3-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@aws-cdk-testing/framework-integ/test/aws-apigatewayv2/test/websocket/integ.stage.js.snapshot/aws-cdk-aws-apigatewayv2-websocket-stage.template.json

+3-2
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,12 @@
1414
"ApiId": {
1515
"Ref": "WebSocketApi34BCF99B"
1616
},
17-
"StageName": "dev",
1817
"DefaultRouteSettings": {
1918
"ThrottlingBurstLimit": 1000,
2019
"ThrottlingRateLimit": 1000
21-
}
20+
},
21+
"Description": "My Stage",
22+
"StageName": "dev"
2223
}
2324
}
2425
},

packages/@aws-cdk-testing/framework-integ/test/aws-apigatewayv2/test/websocket/integ.stage.js.snapshot/cdk.out

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@aws-cdk-testing/framework-integ/test/aws-apigatewayv2/test/websocket/integ.stage.js.snapshot/integ.json

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@aws-cdk-testing/framework-integ/test/aws-apigatewayv2/test/websocket/integ.stage.js.snapshot/manifest.json

+9-8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@aws-cdk-testing/framework-integ/test/aws-apigatewayv2/test/websocket/integ.stage.js.snapshot/tree.json

+37-20
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@aws-cdk-testing/framework-integ/test/aws-apigatewayv2/test/websocket/integ.stage.ts

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ new apigw.WebSocketStage(stack, 'WebSocketStage', {
1313
rateLimit: 1000,
1414
burstLimit: 1000,
1515
},
16+
description: 'My Stage',
1617
});
1718

1819
app.synth();

0 commit comments

Comments
 (0)