refactor(ecs): normalize memory and cpu props between ec2/fargate (#2830

) Normalize all memory and cpu props between ec2 and fargate launch types BREAKING CHANGES: * **ecs** Fargate classes take MemoryMiB renamed to MemoryLimitMiB. * **ecs** Fargate classes take both CPU and MemoryLimitMiB as numbers not strings.
aws · Jun 12, 2019 · 11598c0 · 11598c0
1 parent b3260a3
commit 11598c0
Show file tree

Hide file tree

Showing 11 changed files with 28 additions and 28 deletions.
diff --git a/packages/@aws-cdk/aws-ecs-patterns/README.md b/packages/@aws-cdk/aws-ecs-patterns/README.md
@@ -42,8 +42,8 @@ const loadBalancedEcsService = new ecsPatterns.LoadBalancedEc2Service(stack, 'Se
 ```ts
 const loadBalancedFargateService = new ecsPatterns.LoadBalancedFargateService(stack, 'Service', {
   cluster,
-  memoryMiB: '1GB',
-  cpu: '512',
+  memoryLimitMiB: 1024,
+  cpu: 512,
   image: ecs.ContainerImage.fromRegistry("amazon/amazon-ecs-sample"),
 });
 ```
@@ -76,7 +76,7 @@ const queueProcessingEc2Service = new QueueProcessingEc2Service(stack, 'Service'
 ```ts
 const queueProcessingFargateService = new QueueProcessingFargateService(stack, 'Service', {
   cluster,
-  memoryMiB: '512',
+  memoryLimitMiB: 512,
   image: ecs.ContainerImage.fromRegistry('test'),
   command: ["-c", "4", "amazon.com"],
   enableLogging: false,

diff --git a/packages/@aws-cdk/aws-ecs-patterns/lib/fargate/load-balanced-fargate-service.ts b/packages/@aws-cdk/aws-ecs-patterns/lib/fargate/load-balanced-fargate-service.ts
@@ -19,7 +19,7 @@ export interface LoadBalancedFargateServiceProps extends LoadBalancedServiceBase
    *
    * @default 256
    */
-  readonly cpu?: string;
+  readonly cpu?: number;
 
   /**
    * The amount (in MiB) of memory used by the task.
@@ -41,7 +41,7 @@ export interface LoadBalancedFargateServiceProps extends LoadBalancedServiceBase
    *
    * @default 512
    */
-  readonly memoryMiB?: string;
+  readonly memoryLimitMiB?: number;
 }
 
 /**
@@ -58,7 +58,7 @@ export class LoadBalancedFargateService extends LoadBalancedServiceBase {
     super(scope, id, props);
 
     const taskDefinition = new ecs.FargateTaskDefinition(this, 'TaskDef', {
-      memoryMiB: props.memoryMiB,
+      memoryLimitMiB: props.memoryLimitMiB,
       cpu: props.cpu
     });
 

diff --git a/packages/@aws-cdk/aws-ecs-patterns/lib/fargate/queue-processing-fargate-service.ts b/packages/@aws-cdk/aws-ecs-patterns/lib/fargate/queue-processing-fargate-service.ts
@@ -19,7 +19,7 @@ export interface QueueProcessingFargateServiceProps extends QueueProcessingServi
    *
    * @default 256
    */
-  readonly cpu?: string;
+  readonly cpu?: number;
 
   /**
    * The amount (in MiB) of memory used by the task.
@@ -41,7 +41,7 @@ export interface QueueProcessingFargateServiceProps extends QueueProcessingServi
    *
    * @default 512
    */
-  readonly memoryMiB?: string;
+  readonly memoryLimitMiB?: number;
 }
 
 /**
@@ -58,8 +58,8 @@ export class QueueProcessingFargateService extends QueueProcessingServiceBase {
 
     // Create a Task Definition for the container to start
     const taskDefinition = new ecs.FargateTaskDefinition(this, 'QueueProcessingTaskDef', {
-      memoryMiB: props.memoryMiB !== undefined ? props.memoryMiB : '512',
-      cpu: props.cpu !== undefined ? props.cpu : '256',
+      memoryLimitMiB: props.memoryLimitMiB,
+      cpu: props.cpu,
     });
     taskDefinition.addContainer('QueueProcessingContainer', {
       image: props.image,

diff --git a/packages/@aws-cdk/aws-ecs-patterns/test/fargate/integ.l3.expected.json b/packages/@aws-cdk/aws-ecs-patterns/test/fargate/integ.l3.expected.json
@@ -513,7 +513,7 @@
           ]
         },
         "Family": "awsecsintegL3TaskDefAA25240E",
-        "Memory": "1GB",
+        "Memory": "1024",
         "NetworkMode": "awsvpc",
         "RequiresCompatibilities": [
           "FARGATE"

diff --git a/packages/@aws-cdk/aws-ecs-patterns/test/fargate/integ.l3.ts b/packages/@aws-cdk/aws-ecs-patterns/test/fargate/integ.l3.ts
@@ -12,8 +12,8 @@ const cluster = new ecs.Cluster(stack, 'FargateCluster', { vpc });
 
 new ecsPatterns.LoadBalancedFargateService(stack, 'L3', {
   cluster,
-  memoryMiB: '1GB',
-  cpu: '512',
+  memoryLimitMiB: 1024,
+  cpu: 512,
   image: ecs.ContainerImage.fromRegistry("amazon/amazon-ecs-sample"),
 });
 

diff --git a/packages/@aws-cdk/aws-ecs-patterns/test/fargate/test.queue-processing-fargate-service.ts b/packages/@aws-cdk/aws-ecs-patterns/test/fargate/test.queue-processing-fargate-service.ts
@@ -17,7 +17,7 @@ export = {
     // WHEN
     new ecsPatterns.QueueProcessingFargateService(stack, 'Service', {
       cluster,
-      memoryMiB: '512',
+      memoryLimitMiB: 512,
       image: ecs.ContainerImage.fromRegistry('test')
     });
 
@@ -74,7 +74,7 @@ export = {
     // WHEN
     new ecsPatterns.QueueProcessingFargateService(stack, 'Service', {
       cluster,
-      memoryMiB: '512',
+      memoryLimitMiB: 512,
       image: ecs.ContainerImage.fromRegistry('test'),
       command: ["-c", "4", "amazon.com"],
       enableLogging: false,

diff --git a/packages/@aws-cdk/aws-ecs/README.md b/packages/@aws-cdk/aws-ecs/README.md
@@ -135,12 +135,12 @@ To run a task or service with Amazon EC2 launch type, use the `Ec2TaskDefinition
 `FargateTaskDefinition`. These classes provide a simplified API that only contain
 properties relevant for that specific launch type.
 
-For a `FargateTaskDefinition`, specify the task size (`memoryMiB` and `cpu`):
+For a `FargateTaskDefinition`, specify the task size (`memoryLimitMiB` and `cpu`):
 
 ```ts
 const fargateTaskDefinition = new ecs.FargateTaskDefinition(this, 'TaskDef', {
-  memoryMiB: '512',
-  cpu: '256'
+  memoryLimitMiB: 512,
+  cpu: 256
 });
 ```
 To add containers to a task definition, call `addContainer()`:
@@ -186,7 +186,7 @@ The following example uses both:
 ```ts
 const taskDefinition = new ecs.TaskDefinition(this, 'TaskDef', {
   memoryMiB: '512',
-  cpu: 256,
+  cpu: '256',
   networkMode: 'awsvpc',
   compatibility: ecs.Compatibility.Ec2AndFargate,
 });

diff --git a/packages/@aws-cdk/aws-ecs/lib/fargate/fargate-task-definition.ts b/packages/@aws-cdk/aws-ecs/lib/fargate/fargate-task-definition.ts
@@ -16,7 +16,7 @@ export interface FargateTaskDefinitionProps extends CommonTaskDefinitionProps {
    *
    * @default 256
    */
-  readonly cpu?: string;
+  readonly cpu?: number;
 
   /**
    * The amount (in MiB) of memory used by the task.
@@ -36,7 +36,7 @@ export interface FargateTaskDefinitionProps extends CommonTaskDefinitionProps {
    *
    * @default 512
    */
-  readonly memoryMiB?: string;
+  readonly memoryLimitMiB?: number;
 }
 
 export interface IFargateTaskDefinition extends ITaskDefinition {
@@ -71,8 +71,8 @@ export class FargateTaskDefinition extends TaskDefinition implements IFargateTas
   constructor(scope: Construct, id: string, props: FargateTaskDefinitionProps = {}) {
     super(scope, id, {
       ...props,
-      cpu: props.cpu || '256',
-      memoryMiB: props.memoryMiB || '512',
+      cpu: props.cpu !== undefined ? String(props.cpu) : '256',
+      memoryMiB: props.memoryLimitMiB !== undefined ? String(props.memoryLimitMiB) : '512',
       compatibility: Compatibility.Fargate,
       networkMode: NetworkMode.AwsVpc,
     });

diff --git a/packages/@aws-cdk/aws-ecs/test/fargate/integ.lb-awsvpc-nw.expected.json b/packages/@aws-cdk/aws-ecs/test/fargate/integ.lb-awsvpc-nw.expected.json
@@ -395,7 +395,7 @@
         ],
         "Cpu": "512",
         "Family": "awsecsintegTaskDef6FDFB69A",
-        "Memory": "1GB",
+        "Memory": "1024",
         "NetworkMode": "awsvpc",
         "RequiresCompatibilities": [
           "FARGATE"

diff --git a/packages/@aws-cdk/aws-ecs/test/fargate/integ.lb-awsvpc-nw.ts b/packages/@aws-cdk/aws-ecs/test/fargate/integ.lb-awsvpc-nw.ts
@@ -11,8 +11,8 @@ const vpc = new ec2.Vpc(stack, 'Vpc', { maxAZs: 2 });
 const cluster = new ecs.Cluster(stack, 'FargateCluster', { vpc });
 
 const taskDefinition = new ecs.FargateTaskDefinition(stack, 'TaskDef', {
-  memoryMiB: '1GB',
-  cpu: '512'
+  memoryLimitMiB: 1024,
+  cpu: 512
 });
 
 const container = taskDefinition.addContainer('web', {

diff --git a/packages/@aws-cdk/aws-stepfunctions-tasks/test/integ.fargate-task.ts b/packages/@aws-cdk/aws-stepfunctions-tasks/test/integ.fargate-task.ts
@@ -16,8 +16,8 @@ const cluster = new ecs.Cluster(stack, 'FargateCluster', { vpc });
 
 // Build task definition
 const taskDefinition = new ecs.FargateTaskDefinition(stack, 'TaskDef', {
-  memoryMiB: '512',
-  cpu: '256'
+  memoryLimitMiB: 512,
+  cpu: 256
 });
 taskDefinition.addContainer('TheContainer', {
   image: ecs.ContainerImage.fromAsset(stack, 'EventImage', { directory: path.resolve(__dirname, 'eventhandler-image') }),