feat(ecs-patterns): refactor fargate interfaces and add support for r…

…untimePlatform (aws#21529) Stemming from aws#20756, currently there are a lot of duplicated Fargate props throughout the library ie `cpu`, `memory`. This can make adding Fargate properties tedious as you have to add them into every Fargate type. This PR introduces `FargateServiceBaseProps` which will hold all of the common Fargate properties and allows all Fargate variations to inherit from. As an example, I have added in `runtimePlatform` to all Fargate services. I still need to make a small README update, but want to get this pushed up for thoughts/suggestions/feedback. closes aws#20756 aws#18462 ---- ### All Submissions: * [x ] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) ### Adding new Unconventional Dependencies: * [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies) ### New Features * [x] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)? * [x] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
josephedward · Aug 30, 2022 · 7722816 · 7722816
1 parent 09116dc
commit 7722816
Show file tree

Hide file tree

Showing 19 changed files with 1,866 additions and 357 deletions.
diff --git a/packages/@aws-cdk/aws-ecs-patterns/README.md b/packages/@aws-cdk/aws-ecs-patterns/README.md
@@ -818,6 +818,22 @@ loadBalancedFargateService.targetGroups[1].configureHealthCheck({
 
 ```
 
+### Set runtimePlatform for ApplicationLoadBalancedFargateService
+
+```ts
+declare const cluster: ecs.Cluster;
+const applicationLoadBalancedFargateService = new ecsPatterns.ApplicationLoadBalancedFargateService(this, 'Service', {
+  cluster,
+  memoryLimitMiB: 512,
+  taskImageOptions: {
+    image: ecs.ContainerImage.fromRegistry('amazon/amazon-ecs-sample'),
+  },
+  runtimePlatform: {
+    cpuArchitecture: ecs.CpuArchitecture.ARM64,
+    operatingSystemFamily: ecs.OperatingSystemFamily.LINUX,
+  },
+});
+```
 
 ### Set PlatformVersion for ScheduledFargateTask
 

diff --git a/packages/@aws-cdk/aws-ecs-patterns/lib/base/fargate-service-base.ts b/packages/@aws-cdk/aws-ecs-patterns/lib/base/fargate-service-base.ts
@@ -0,0 +1,74 @@
+import { FargatePlatformVersion, FargateTaskDefinition, RuntimePlatform } from '@aws-cdk/aws-ecs';
+
+
+export interface FargateServiceBaseProps {
+  /**
+   * The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.
+   *
+   * [disable-awslint:ref-via-interface]
+   *
+   * @default - none
+   */
+  readonly taskDefinition?: FargateTaskDefinition;
+
+  /**
+   * The number of cpu units used by the task.
+   *
+   * Valid values, which determines your range of valid values for the memory parameter:
+   *
+   * 256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB
+   *
+   * 512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB
+   *
+   * 1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB
+   *
+   * 2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments
+   *
+   * 4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments
+   *
+   * This default is set in the underlying FargateTaskDefinition construct.
+   *
+   * @default 256
+   */
+  readonly cpu?: number;
+
+  /**
+    * The amount (in MiB) of memory used by the task.
+    *
+    * This field is required and you must use one of the following values, which determines your range of valid values
+    * for the cpu parameter:
+    *
+    * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
+    *
+    * 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
+    *
+    * 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
+    *
+    * Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
+    *
+    * Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
+    *
+    * This default is set in the underlying FargateTaskDefinition construct.
+    *
+    * @default 512
+    */
+  readonly memoryLimitMiB?: number;
+
+  /**
+   * The platform version on which to run your service.
+   *
+   * If one is not specified, the LATEST platform version is used by default. For more information, see
+   * [AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
+   * in the Amazon Elastic Container Service Developer Guide.
+   *
+   * @default Latest
+   */
+  readonly platformVersion?: FargatePlatformVersion;
+
+  /**
+   * The runtime platform of the task definition
+   *
+   * @default - If the property is undefined, `operatingSystemFamily` is LINUX and `cpuArchitecture` is X86_64
+   */
+  readonly runtimePlatform?: RuntimePlatform;
+}
diff --git a/packages/@aws-cdk/aws-ecs-patterns/lib/fargate/application-load-balanced-fargate-service.ts b/packages/@aws-cdk/aws-ecs-patterns/lib/fargate/application-load-balanced-fargate-service.ts
@@ -1,66 +1,14 @@
 import { ISecurityGroup, SubnetSelection } from '@aws-cdk/aws-ec2';
-import { FargatePlatformVersion, FargateService, FargateTaskDefinition } from '@aws-cdk/aws-ecs';
+import { FargateService, FargateTaskDefinition } from '@aws-cdk/aws-ecs';
 import { FeatureFlags } from '@aws-cdk/core';
 import * as cxapi from '@aws-cdk/cx-api';
 import { Construct } from 'constructs';
 import { ApplicationLoadBalancedServiceBase, ApplicationLoadBalancedServiceBaseProps } from '../base/application-load-balanced-service-base';
-
+import { FargateServiceBaseProps } from '../base/fargate-service-base';
 /**
  * The properties for the ApplicationLoadBalancedFargateService service.
  */
-export interface ApplicationLoadBalancedFargateServiceProps extends ApplicationLoadBalancedServiceBaseProps {
-  /**
-   * The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.
-   *
-   * [disable-awslint:ref-via-interface]
-   *
-   * @default - none
-   */
-  readonly taskDefinition?: FargateTaskDefinition;
-
-  /**
-   * The number of cpu units used by the task.
-   *
-   * Valid values, which determines your range of valid values for the memory parameter:
-   *
-   * 256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB
-   *
-   * 512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB
-   *
-   * 1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB
-   *
-   * 2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments
-   *
-   * 4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments
-   *
-   * This default is set in the underlying FargateTaskDefinition construct.
-   *
-   * @default 256
-   */
-  readonly cpu?: number;
-
-  /**
-   * The amount (in MiB) of memory used by the task.
-   *
-   * This field is required and you must use one of the following values, which determines your range of valid values
-   * for the cpu parameter:
-   *
-   * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
-   *
-   * 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
-   *
-   * 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
-   *
-   * Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
-   *
-   * Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
-   *
-   * This default is set in the underlying FargateTaskDefinition construct.
-   *
-   * @default 512
-   */
-  readonly memoryLimitMiB?: number;
-
+export interface ApplicationLoadBalancedFargateServiceProps extends ApplicationLoadBalancedServiceBaseProps, FargateServiceBaseProps {
   /**
    * Determines whether the service will be assigned a public IP address.
    *
@@ -75,17 +23,6 @@ export interface ApplicationLoadBalancedFargateServiceProps extends ApplicationL
    */
   readonly taskSubnets?: SubnetSelection;
 
-  /**
-   * The platform version on which to run your service.
-   *
-   * If one is not specified, the LATEST platform version is used by default. For more information, see
-   * [AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
-   * in the Amazon Elastic Container Service Developer Guide.
-   *
-   * @default Latest
-   */
-  readonly platformVersion?: FargatePlatformVersion;
-
   /**
    * The security groups to associate with the service. If you do not specify a security group, a new security group is created.
    *
@@ -133,6 +70,7 @@ export class ApplicationLoadBalancedFargateService extends ApplicationLoadBalanc
         executionRole: taskImageOptions.executionRole,
         taskRole: taskImageOptions.taskRole,
         family: taskImageOptions.family,
+        runtimePlatform: props.runtimePlatform,
       });
 
       // Create log driver if logging is enabled

diff --git a/...ws-cdk/aws-ecs-patterns/lib/fargate/application-multiple-target-groups-fargate-service.ts b/...ws-cdk/aws-ecs-patterns/lib/fargate/application-multiple-target-groups-fargate-service.ts
@@ -1,4 +1,4 @@
-import { FargatePlatformVersion, FargateService, FargateTaskDefinition } from '@aws-cdk/aws-ecs';
+import { FargateService, FargateTaskDefinition } from '@aws-cdk/aws-ecs';
 import { ApplicationTargetGroup } from '@aws-cdk/aws-elasticloadbalancingv2';
 import { FeatureFlags } from '@aws-cdk/core';
 import * as cxapi from '@aws-cdk/cx-api';
@@ -7,81 +7,19 @@ import {
   ApplicationMultipleTargetGroupsServiceBase,
   ApplicationMultipleTargetGroupsServiceBaseProps,
 } from '../base/application-multiple-target-groups-service-base';
+import { FargateServiceBaseProps } from '../base/fargate-service-base';
 
 /**
  * The properties for the ApplicationMultipleTargetGroupsFargateService service.
  */
-export interface ApplicationMultipleTargetGroupsFargateServiceProps extends ApplicationMultipleTargetGroupsServiceBaseProps {
-
-  /**
-   * The task definition to use for tasks in the service. Only one of TaskDefinition or TaskImageOptions must be specified.
-   *
-   * [disable-awslint:ref-via-interface]
-   *
-   * @default - none
-   */
-  readonly taskDefinition?: FargateTaskDefinition;
-
-  /**
-   * The number of cpu units used by the task.
-   *
-   * Valid values, which determines your range of valid values for the memory parameter:
-   *
-   * 256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB
-   *
-   * 512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB
-   *
-   * 1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB
-   *
-   * 2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments
-   *
-   * 4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments
-   *
-   * This default is set in the underlying FargateTaskDefinition construct.
-   *
-   * @default 256
-   */
-  readonly cpu?: number;
-
-  /**
-   * The amount (in MiB) of memory used by the task.
-   *
-   * This field is required and you must use one of the following values, which determines your range of valid values
-   * for the cpu parameter:
-   *
-   * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
-   *
-   * 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
-   *
-   * 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
-   *
-   * Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
-   *
-   * Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
-   *
-   * This default is set in the underlying FargateTaskDefinition construct.
-   *
-   * @default 512
-   */
-  readonly memoryLimitMiB?: number;
+export interface ApplicationMultipleTargetGroupsFargateServiceProps extends ApplicationMultipleTargetGroupsServiceBaseProps, FargateServiceBaseProps {
 
   /**
    * Determines whether the service will be assigned a public IP address.
    *
    * @default false
    */
   readonly assignPublicIp?: boolean;
-
-  /**
-   * The platform version on which to run your service.
-   *
-   * If one is not specified, the LATEST platform version is used by default. For more information, see
-   * [AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
-   * in the Amazon Elastic Container Service Developer Guide.
-   *
-   * @default Latest
-   */
-  readonly platformVersion?: FargatePlatformVersion;
 }
 
 /**
@@ -130,6 +68,7 @@ export class ApplicationMultipleTargetGroupsFargateService extends ApplicationMu
         executionRole: taskImageOptions.executionRole,
         taskRole: taskImageOptions.taskRole,
         family: taskImageOptions.family,
+        runtimePlatform: props.runtimePlatform,
       });
 
       const containerName = taskImageOptions.containerName ?? 'web';

diff --git a/packages/@aws-cdk/aws-ecs-patterns/lib/fargate/network-load-balanced-fargate-service.ts b/packages/@aws-cdk/aws-ecs-patterns/lib/fargate/network-load-balanced-fargate-service.ts
@@ -1,65 +1,15 @@
 import { SubnetSelection } from '@aws-cdk/aws-ec2';
-import { FargatePlatformVersion, FargateService, FargateTaskDefinition } from '@aws-cdk/aws-ecs';
+import { FargateService, FargateTaskDefinition } from '@aws-cdk/aws-ecs';
 import { FeatureFlags } from '@aws-cdk/core';
 import * as cxapi from '@aws-cdk/cx-api';
 import { Construct } from 'constructs';
+import { FargateServiceBaseProps } from '../base/fargate-service-base';
 import { NetworkLoadBalancedServiceBase, NetworkLoadBalancedServiceBaseProps } from '../base/network-load-balanced-service-base';
 
 /**
  * The properties for the NetworkLoadBalancedFargateService service.
  */
-export interface NetworkLoadBalancedFargateServiceProps extends NetworkLoadBalancedServiceBaseProps {
-  /**
-   * The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.
-   *
-   * [disable-awslint:ref-via-interface]
-   *
-   * @default - none
-   */
-  readonly taskDefinition?: FargateTaskDefinition;
-
-  /**
-   * The number of cpu units used by the task.
-   *
-   * Valid values, which determines your range of valid values for the memory parameter:
-   *
-   * 256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB
-   *
-   * 512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB
-   *
-   * 1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB
-   *
-   * 2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments
-   *
-   * 4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments
-   *
-   * This default is set in the underlying FargateTaskDefinition construct.
-   *
-   * @default 256
-   */
-  readonly cpu?: number;
-
-  /**
-   * The amount (in MiB) of memory used by the task.
-   *
-   * This field is required and you must use one of the following values, which determines your range of valid values
-   * for the cpu parameter:
-   *
-   * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
-   *
-   * 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
-   *
-   * 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
-   *
-   * Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
-   *
-   * Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
-   *
-   * This default is set in the underlying FargateTaskDefinition construct.
-   *
-   * @default 512
-   */
-  readonly memoryLimitMiB?: number;
+export interface NetworkLoadBalancedFargateServiceProps extends NetworkLoadBalancedServiceBaseProps, FargateServiceBaseProps {
 
   /**
    * Determines whether the service will be assigned a public IP address.
@@ -75,16 +25,6 @@ export interface NetworkLoadBalancedFargateServiceProps extends NetworkLoadBalan
    */
   readonly taskSubnets?: SubnetSelection;
 
-  /**
-   * The platform version on which to run your service.
-   *
-   * If one is not specified, the LATEST platform version is used by default. For more information, see
-   * [AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
-   * in the Amazon Elastic Container Service Developer Guide.
-   *
-   * @default Latest
-   */
-  readonly platformVersion?: FargatePlatformVersion;
 }
 
 /**
@@ -122,6 +62,7 @@ export class NetworkLoadBalancedFargateService extends NetworkLoadBalancedServic
         executionRole: taskImageOptions.executionRole,
         taskRole: taskImageOptions.taskRole,
         family: taskImageOptions.family,
+        runtimePlatform: props.runtimePlatform,
       });
 
       // Create log driver if logging is enabled