Skip to content

Commit 0e268f9

Browse files
Abogicaliankhou
authored andcommitted
docs(ecs): add note for windows tasks CPU/Memory requirement (#34683)
Adds a clarification note that these properties are not strictly enforced at runtime, but are still required nonetheless. ### Issue #34645 Fixes #34645. ### Reason for this change [ECS docs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size) was recently updated to state that the CPU/Memory property is not enforced on Windows platforms, but are still required nonetheless. ### Description of changes Add note to the CPU and memory property of Fargate task definitions. ### Describe any new or updated permissions being added No permissions added or updated. ### Description of how you validated changes No tests needed as this is a documentation change. ### 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 b5ef88b commit 0e268f9

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

packages/aws-cdk-lib/aws-ecs/lib/fargate/fargate-task-definition.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@ export interface FargateTaskDefinitionProps extends CommonTaskDefinitionProps {
3737
*
3838
* 16384 (16 vCPU) - Available memory values: Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB)
3939
*
40+
* Note: For windows platforms, this field is not enforced at runtime. However, it is still required as it is used to determine
41+
* the instance type and size that tasks run on.
42+
*
4043
* @default 256
4144
*/
4245
readonly cpu?: number;
@@ -59,6 +62,9 @@ export interface FargateTaskDefinitionProps extends CommonTaskDefinitionProps {
5962
*
6063
* Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB) - Available cpu values: 16384 (16 vCPU)
6164
*
65+
* Note: For windows platforms, this field is not enforced at runtime. However, it is still required as it is used to determine
66+
* the instance type and size that tasks run on.
67+
*
6268
* @default 512
6369
*/
6470
readonly memoryLimitMiB?: number;

0 commit comments

Comments
 (0)