fix(appconfig): fromDeploymentStrategyId takes an enum-like class rather than a string #28743
Conversation
github-actions
bot
added
p2
valued-contributor
There was a problem hiding this comment.
The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.
A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.
kaizencc
added
the
pr-linter/exempt-integ-test
aws-cdk-automation
dismissed
their stale review
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
aws-cdk-automation
added
the
pr/needs-community-review
kaizencc
changed the title
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
…28671) Auditing awslint errors. Reasons for keeping current list of exemptions: * "no-unused-type:@aws-cdk/aws-appconfig-alpha.PredefinedDeploymentStrategyId" - will be fixed in a separate PR. * "props-physical-name:@aws-cdk/aws-appconfig-alpha.ApplicationProps" "props-physical-name:@aws-cdk/aws-appconfig-alpha.DeploymentStrategyProps" "props-physical-name:@aws-cdk/aws-appconfig-alpha.EnvironmentProps" "props-physical-name:@aws-cdk/aws-appconfig-alpha.ExtensionProps" - will be fixed in a separate PR. * "events-method-signature" - exempting because appconfig handles their events without cloudwatch events * "events-generic" - exempting because appconfig handles their events without cloudwatch events Closes #27894 alongside #28742 and #28743 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Previously, we were typing this as a
stringand providing an enum forPredefinedDeploymentStrategyIds. This is a CDK anti-pattern because this makes the enum undiscoverable, since users see that it is typed only as astring. It also may not work in non-TS languages. Instead, we are moving the type to explicitly be an enum-like class.Follow up from #28671.
BREAKING CHANGE:
deploymentStrategyIdprop infromDeploymentStrategyIdnow takes aDeploymentStrategyIdrather than astring. To import a predefined deployment strategy id, useDeploymentStrategyId.CANARY_10_PERCENT_20_MINUTES. Otherwise, useDeploymentStrategyId.fromString('abc123').By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license