-
Notifications
You must be signed in to change notification settings - Fork 4.3k
docs(batch): correct default allocation strategy for spot compute environments #36356
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
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.
|
||||||||||||||
|
||||||||||||||
badmintoncryer
left a comment
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!
|
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). |
Merge Queue Status🚫 The pull request has left the queue (rule: This pull request spent 3 minutes 59 seconds in the queue, with no time running CI. ReasonThe pull request can't be updated
HintYou should update or rebase your pull request manually. If you do, this pull request will automatically be requeued once the queue conditions match again. |
|
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). |
Issue # (if applicable)
Closes #36348.
Reason for this change
The AWS Batch documentation within the CDK library incorrectly stated that the default Spot allocation strategy is
SPOT_CAPACITY_OPTIMIZED. However, the default was changed toSPOT_PRICE_CAPACITY_OPTIMIZEDin PR #26731 (August 2023), and several JSDoc@defaultannotations were never updated.This resulted in inconsistencies between:
determineAllocationStrategy()), which correctly usesSPOT_PRICE_CAPACITY_OPTIMIZEDThis PR updates the documentation to accurately reflect the correct behavior.
Description of changes
@defaultannotations inmanaged-compute-environment.ts.SPOT_CAPACITY_OPTIMIZEDwithSPOT_PRICE_CAPACITY_OPTIMIZEDin affected interfaces and props.IManagedEc2EcsComputeEnvironmentManagedEc2EcsComputeEnvironmentPropsIManagedEc2EksComputeEnvironmentManagedEc2EksComputeEnvironmentPropsAlternatives considered:
Design decisions:
Describe any new or updated permissions being added
No new or updated IAM permissions are introduced.
This PR updates documentation only.
Description of how you validated changes
determineAllocationStrategy()already uses the correct default (SPOT_PRICE_CAPACITY_OPTIMIZED).@defaultcomments and corrected them.Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license