fix(batch): make instanceType optional on multinode jobs (#27223)

Make `instanceType` optional. It used to be required. It will default to a batch optimal instance type. The breaking change is for `MultiNodeJobDefinition.instanceType`, which is now optional. This is not truly breaking because everyone has this property explicitly set now, and will continue to have it set after this change. Closes #27185. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
aws · Sep 26, 2023 · 6616026 · 6616026
1 parent acd0ace
commit 6616026
Show file tree

Hide file tree

Showing 8 changed files with 156 additions and 92 deletions.
diff --git a/...mework-integ/test/aws-batch/test/integ.multinode-job-definition.js.snapshot/manifest.json b/...mework-integ/test/aws-batch/test/integ.multinode-job-definition.js.snapshot/manifest.json
diff --git a/...rk-integ/test/aws-batch/test/integ.multinode-job-definition.js.snapshot/stack.assets.json b/...rk-integ/test/aws-batch/test/integ.multinode-job-definition.js.snapshot/stack.assets.json
diff --git a/...-integ/test/aws-batch/test/integ.multinode-job-definition.js.snapshot/stack.template.json b/...-integ/test/aws-batch/test/integ.multinode-job-definition.js.snapshot/stack.template.json
@@ -76,7 +76,6 @@
          ]
         },
         "Image": "amazon/amazon-ecs-sample",
-        "InstanceType": "r4.large",
         "ReadonlyRootFilesystem": false,
         "ResourceRequirements": [
          {

diff --git a/.../framework-integ/test/aws-batch/test/integ.multinode-job-definition.js.snapshot/tree.json b/.../framework-integ/test/aws-batch/test/integ.multinode-job-definition.js.snapshot/tree.json
diff --git a/...es/@aws-cdk-testing/framework-integ/test/aws-batch/test/integ.multinode-job-definition.ts b/...es/@aws-cdk-testing/framework-integ/test/aws-batch/test/integ.multinode-job-definition.ts
@@ -8,7 +8,6 @@ const app = new App();
 const stack = new Stack(app, 'stack');
 
 new batch.MultiNodeJobDefinition(stack, 'SingleContainerMultiNodeJob', {
-  instanceType: InstanceType.of(InstanceClass.R4, InstanceSize.LARGE),
   containers: [{
     startNode: 0,
     endNode: 10,

diff --git a/packages/aws-cdk-lib/aws-batch/README.md b/packages/aws-cdk-lib/aws-batch/README.md
@@ -556,7 +556,7 @@ In particular, the environment variable that tells the containers which one is t
 
 ```ts
 const multiNodeJob = new batch.MultiNodeJobDefinition(this, 'JobDefinition', {
-  instanceType: ec2.InstanceType.of(ec2.InstanceClass.R4, ec2.InstanceSize.LARGE),
+  instanceType: ec2.InstanceType.of(ec2.InstanceClass.R4, ec2.InstanceSize.LARGE), // optional, omit to let Batch choose the type for you
   containers: [{
     container: new batch.EcsEc2ContainerDefinition(this, 'mainMPIContainer', {
       image: ecs.ContainerImage.fromRegistry('yourregsitry.com/yourMPIImage:latest'),