-
Notifications
You must be signed in to change notification settings - Fork 4.1k
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.
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(servicecatalog): added property productType
for CloudFormationProduct
#33792
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(This review is outdated)
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #33792 +/- ##
=======================================
Coverage 82.38% 82.38%
=======================================
Files 120 120
Lines 6937 6937
Branches 1170 1170
=======================================
Hits 5715 5715
Misses 1119 1119
Partials 103 103
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for your contribution! I have nothing to say about the implementation! I would like you to make some corrections to the documentation.
@@ -117,6 +143,12 @@ export interface CloudFormationProductProps { | |||
*/ | |||
readonly distributor?: string; | |||
|
|||
/** | |||
* The type of the product. | |||
* @default - No type provided |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you please describe which type is set by default if undefined
is passed?
When not explicitly setting the default value in CDK, it seems to be preferred by maintainers recently to explicitly describe what behavior occurs as the CloudFormation default, as shown below.
- https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-sns/lib/topic.ts#L109
- https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-cognito/lib/user-pool.ts#L468
You don't necessarily need to adhere to it, but you might receive such feedback from the maintainers.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about explaining that it's possible to create Terraform and external products by configuring the productType
?
Reason for this change
This feature allows customers to create Service Catalog products of different types, such as CloudFormation templates, Terraform configurations, or external products.
Description of changes
These changes enable customers to specify the product type when creating a Service Catalog product with
CloudFormationProduct
.Description of how you validated changes
The changes have been validated through the addition of a new unit test case and the integration test that verifies the
ProductType
configuration.Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license