Skip to content

Commit 88f3e04

Browse files
authored
docs: update ECS service and Fargate documentation for new AZ rebalancing default values (#35156)
Updates documentation to reflect ECS change in default behavior for the `AvailabilityZoneRebalancing` property: - For create service requests, when no value is specified for AvailabilityZoneRebalancing, Amazon ECS defaults to ENABLED if the ECS service is compatible with AvailabilityZoneRebalancing. If the ECS service is not compatible with AvailabilityZoneRebalancing, Amazon ECS defaults to DISABLED. - For update service requests, when no value is specified for AvailabilityZoneRebalancing, Amazon ECS defaults to the existing service’s AvailabilityZoneRebalancing value. If the service never had an AvailabilityZoneRebalancing value set, Amazon ECS treats this as DISABLED. ### Issue # (if applicable) Closes #<issue number here>. ### Reason for this change <!--What is the bug or use case behind this change?--> ### Description of changes <!-- What code changes did you make? Why do these changes address the issue? What alternatives did you consider and reject? What design decisions have you made? --> ### Describe any new or updated permissions being added <!-- What new or updated IAM permissions are needed to support the changes being introduced? --> ### Description of how you validated changes <!-- Have you added any unit tests and/or integration tests? Did you test by hand? --> ### 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 33703c7 commit 88f3e04

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

packages/aws-cdk-lib/aws-ecs/lib/ec2/ec2-service.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ export interface Ec2ServiceProps extends BaseServiceOptions {
9696
* service must not be a target of a Classic Load Balancer.
9797
*
9898
* @see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html
99-
* @default AvailabilityZoneRebalancing.DISABLED
99+
* @default AvailabilityZoneRebalancing.ENABLED
100100
*/
101101
readonly availabilityZoneRebalancing?: AvailabilityZoneRebalancing;
102102
}

packages/aws-cdk-lib/aws-ecs/lib/fargate/fargate-service.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ export interface FargateServiceProps extends BaseServiceOptions {
7171
* of a Classic Load Balancer.
7272
*
7373
* @see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html
74-
* @default AvailabilityZoneRebalancing.DISABLED
74+
* @default AvailabilityZoneRebalancing.ENABLED
7575
*/
7676
readonly availabilityZoneRebalancing?: AvailabilityZoneRebalancing;
7777
}

0 commit comments

Comments
 (0)