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.

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

fix(ecs): let AsgCapacityProvider use IAutoScalingGroup only when Managed Termination Protection is disable #30335

Merged
merged 12 commits into from
Jun 25, 2024

Conversation

scorbiere
Copy link
Contributor

@scorbiere scorbiere commented May 24, 2024

Let AsgCapacityProvider use IAutoScalingGroup only when Managed Termination Protection is disable.

The code will throw an exception with a clear message when the user specify a self managed ASG using AutoScalingGroup.fromAutoScalingGroupName and let the Managed Termination Protection enabled.

It will also throw a clear exception when calling Cluster.addAsgCapacityProvider with an AsgCapacityProvider created with an imported ASG.

Issue # (if applicable)

Closes #29174.

Reason for this change

As there is no clear fix to the original issue, this change's purpose it to bring clarity to the users about what is not allowed when using the L2 Constructs AsgCapacityProvider and Cluster with an imported ASG.

Description of changes

This change will replace non explicit exception, caused by missing methods, by clear error messages.

Description of how you validated changes

Added unit tests.

Checklist


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

…nation Protection is enabled.

The code will emit a warning message but will let the user specify a self managed ASG using `AutoScalingGroup.fromAutoScalingGroupName`.
Also makes sure that when calling `Cluster.addAsgCapacityProvider`, the ASG used is not an imported one.
@github-actions github-actions bot added the p2 label May 24, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team May 24, 2024 23:03
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label May 24, 2024
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@scorbiere scorbiere changed the title Let AsgCapacityProvider use IAutoScalingGroup even when Managed Termi… fix(ecs): Let AsgCapacityProvider use IAutoScalingGroup even when Managed Termination Protection is enabled. May 25, 2024
@scorbiere scorbiere changed the title fix(ecs): Let AsgCapacityProvider use IAutoScalingGroup even when Managed Termination Protection is enabled. fix(ecs): let AsgCapacityProvider use IAutoScalingGroup even when Managed Termination Protection is enabled. May 25, 2024
@github-actions github-actions bot added bug This issue is a bug. effort/medium Medium work item – several days of effort p1 and removed p2 labels May 25, 2024
scorbiere and others added 4 commits June 17, 2024 14:45
### Issue # (if applicable)

Closes aws#29701

### Reason for this change

Calling `overrideLogicalId` on a `Construct` with an invalid logical ID ([docs](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-logicalid)) would not throw an error at synthesis time. CloudFormation would 

### Description of changes

* Validate `overrideLogicalId` (must not be empty, must not be over 255 characters, must match `/^[A-Za-z0-9]+$/`
* Document exceptions with `@error` JSDoc tags

### Description of how you validated changes

I've added unit tests, integration tests should not be necessary

### 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*
@scorbiere scorbiere changed the title fix(ecs): let AsgCapacityProvider use IAutoScalingGroup even when Managed Termination Protection is enabled. chore(ecs): let AsgCapacityProvider use IAutoScalingGroup only when Managed Termination Protection is disable. Jun 20, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review June 20, 2024 18:59

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

@scorbiere scorbiere marked this pull request as ready for review June 21, 2024 17:39
@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jun 21, 2024
@paulhcsun paulhcsun changed the title chore(ecs): let AsgCapacityProvider use IAutoScalingGroup only when Managed Termination Protection is disable. fix(ecs): let AsgCapacityProvider use IAutoScalingGroup only when Managed Termination Protection is disable. Jun 21, 2024
Copy link
Contributor

@paulhcsun paulhcsun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one minor docstring change. Otherwise this looks good, nice work!

packages/aws-cdk-lib/aws-ecs/lib/cluster.ts Outdated Show resolved Hide resolved
@paulhcsun paulhcsun added the pr-linter/exempt-integ-test The PR linter will not require integ test changes label Jun 21, 2024
Co-authored-by: paulhcsun <47882901+paulhcsun@users.noreply.github.com>
@paulhcsun
Copy link
Contributor

@Mergifyio update

Copy link
Contributor

mergify bot commented Jun 24, 2024

update

✅ Branch has been successfully updated

Copy link
Contributor

mergify bot commented Jun 24, 2024

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-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jun 24, 2024
@pahud
Copy link
Contributor

pahud commented Jun 24, 2024

LGTM 🚢

@paulhcsun paulhcsun changed the title fix(ecs): let AsgCapacityProvider use IAutoScalingGroup only when Managed Termination Protection is disable. fix(ecs): let AsgCapacityProvider use IAutoScalingGroup only when Managed Termination Protection is disable Jun 24, 2024
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: d7d6b58
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

Copy link
Contributor

mergify bot commented Jun 25, 2024

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).

@mergify mergify bot merged commit efee07d into aws:main Jun 25, 2024
9 checks passed
@aws-cdk-automation
Copy link
Collaborator

Comments on closed issues and PRs are hard for our team to see. If you need help, please open a new issue that references this one.

@aws aws locked as resolved and limited conversation to collaborators Jul 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug This issue is a bug. contribution/core This is a PR that came from AWS. effort/medium Medium work item – several days of effort p1 pr-linter/exempt-integ-test The PR linter will not require integ test changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

aws-ecs: AsgCapacityProvider depends on AutoScalingGroup
5 participants