feat(batch): add fargate Runtime Platform properties to ECS Fargate C…

packages/@aws-cdk-testing/framework-integ/test/aws-batch/test/integ.ecs-job-definition.js.snapshot/stack.template.json

@@ -828,7 +828,11 @@
        "Type": "VCPU",
        "Value": "16"
       }
-     ]
+     ],
+     "RuntimePlatform": {
+      "CpuArchitecture": "ARM64",
+      "OperatingSystemFamily": "LINUX"
+     }
     },
     "JobDefinitionName": "foofoo",
     "Parameters": {

packages/@aws-cdk-testing/framework-integ/test/aws-batch/test/integ.ecs-job-definition.ts

@@ -60,6 +60,8 @@ new batch.EcsJobDefinition(stack, 'ECSFargateJobDefn', {
     memory: Size.mebibytes(32768),
     ephemeralStorageSize: Size.gibibytes(100),
     fargatePlatformVersion: FargatePlatformVersion.LATEST,
+    fargateCpuArchitecture: ecs.CpuArchitecture.ARM64,
+    fargateOperatingSystemFamily: ecs.OperatingSystemFamily.LINUX,
   }),
   jobDefinitionName: 'foofoo',
   parameters: {

packages/aws-cdk-lib/aws-batch/README.md

@@ -479,6 +479,21 @@ jobDefn.container.addVolume(batch.EcsVolume.efs({
 }));
 ```
 
+### Running a ECS workflow with Fargate container
+
+```ts
+const jobDefn = new batch.EcsJobDefinition(this, 'JobDefn', {
+  container: new batch.EcsFargateContainerDefinition(this, 'myFargateContainer', {
+    image: ecs.ContainerImage.fromRegistry('public.ecr.aws/amazonlinux/amazonlinux:latest'),
+    memory: cdk.Size.mebibytes(2048),
+    cpu: 256,
+    ephemeralStorageSize: cdk.Size.gibibytes(100),
+    fargateCpuArchitecture: ecs.CpuArchitecture.ARM64,
+    fargateOperatingSystemFamily: ecs.OperatingSystemFamily.LINUX,
+  }),
+});
+```
+
 ### Secrets
 
 You can expose SecretsManager Secret ARNs or SSM Parameters to your container as environment variables.

packages/aws-cdk-lib/aws-batch/lib/ecs-container-definition.ts

@@ -979,6 +979,20 @@ export interface IEcsFargateContainerDefinition extends IEcsContainerDefinition
    * @default - 20 GiB
    */
   readonly ephemeralStorageSize?: Size;
+
+  /**
+   * The vCPU architecture of Fargate Runtime.
+   *
+   * @default - X86_64
+   */
+  readonly fargateCpuArchitecture?: ecs.CpuArchitecture;
+
+  /**
+   * The operating system for the compute environment.
+   *
+   * @default - LINUX
+   */
+  readonly fargateOperatingSystemFamily?: ecs.OperatingSystemFamily;
 }
 
 /**
@@ -1009,6 +1023,20 @@ export interface EcsFargateContainerDefinitionProps extends EcsContainerDefiniti
    * @default - 20 GiB
    */
   readonly ephemeralStorageSize?: Size;
+
+  /**
+   * The vCPU architecture of Fargate Runtime.
+   *
+   * @default - X86_64
+   */
+  readonly fargateCpuArchitecture?: ecs.CpuArchitecture;
+
+  /**
+   * The operating system for the compute environment.
+   *
+   * @default - LINUX
+   */
+  readonly fargateOperatingSystemFamily?: ecs.OperatingSystemFamily;
 }
 
 /**
@@ -1018,12 +1046,16 @@ export class EcsFargateContainerDefinition extends EcsContainerDefinitionBase im
   public readonly fargatePlatformVersion?: ecs.FargatePlatformVersion;
   public readonly assignPublicIp?: boolean;
   public readonly ephemeralStorageSize?: Size;
+  public readonly fargateCpuArchitecture?: ecs.CpuArchitecture;
+  public readonly fargateOperatingSystemFamily?: ecs.OperatingSystemFamily;
 
   constructor(scope: Construct, id: string, props: EcsFargateContainerDefinitionProps) {
     super(scope, id, props);
     this.assignPublicIp = props.assignPublicIp;
     this.fargatePlatformVersion = props.fargatePlatformVersion;
     this.ephemeralStorageSize = props.ephemeralStorageSize;
+    this.fargateCpuArchitecture = props.fargateCpuArchitecture;
+    this.fargateOperatingSystemFamily = props.fargateOperatingSystemFamily;
 
     // validates ephemeralStorageSize is within limits
     if (props.ephemeralStorageSize) {
@@ -1050,6 +1082,10 @@ export class EcsFargateContainerDefinition extends EcsContainerDefinitionBase im
       networkConfiguration: {
         assignPublicIp: this.assignPublicIp ? 'ENABLED' : 'DISABLED',
       },
+      runtimePlatform: {
+        cpuArchitecture: this.fargateCpuArchitecture?._cpuArchitecture,
+        operatingSystemFamily: this.fargateOperatingSystemFamily?._operatingSystemFamily,
+      },
     };
   };
 }

packages/aws-cdk-lib/aws-batch/test/ecs-job-definition.test.ts

@@ -63,6 +63,27 @@ test('EcsJobDefinition uses Compatibility.FARGATE for Fargate containers', () =>
   });
 });
 
+test('EcsJobDefinition uses runtimePlatform for Fargate containers', () => {
+  // GIVEN
+  const stack = new Stack();
+
+  // WHEN
+  new EcsJobDefinition(stack, 'ECSJobDefn', {
+    container: new EcsFargateContainerDefinition(stack, 'EcsContainer', {
+      cpu: 256,
+      image: ecs.ContainerImage.fromRegistry('amazon/amazon-ecs-sample'),
+      memory: Size.mebibytes(2048),
+      fargateCpuArchitecture: ecs.CpuArchitecture.ARM64,
+      fargateOperatingSystemFamily: ecs.OperatingSystemFamily.LINUX,
+    }),
+  });
+
+  // THEN
+  Template.fromStack(stack).hasResourceProperties('AWS::Batch::JobDefinition', {
+    PlatformCapabilities: [Compatibility.FARGATE],
+  });
+});
+
 test('can be imported from ARN', () => {
   // GIVEN
   const stack = new Stack();