Merge branch 'main' into automation/spec-update

packages/@aws-cdk-testing/framework-integ/test/aws-stepfunctions-tasks/test/ecs/integ.fargate-run-task.js.snapshot/aws-sfn-tasks-ecs-fargate-run-task.template.json

@@ -828,7 +828,7 @@
  "GroupId"
  ]
  },
- "\"]}},\"Overrides\":{\"ContainerOverrides\":[{\"Name\":\"TheContainer\",\"Environment\":[{\"Name\":\"SOME_KEY\",\"Value.$\":\"$.SomeKey\"}]}]},\"LaunchType\":\"FARGATE\",\"PlatformVersion\":\"1.4.0\"}},\"FargateTaskSetRevisionNumber\":{\"Next\":\"FargateTaskWithPropagatedTag\",\"Type\":\"Task\",\"Resource\":\"arn:",
+ "\"]}},\"Overrides\":{\"Cpu\":\"1024\",\"Memory\":\"2048\",\"ContainerOverrides\":[{\"Name\":\"TheContainer\",\"Environment\":[{\"Name\":\"SOME_KEY\",\"Value.$\":\"$.SomeKey\"}]}]},\"LaunchType\":\"FARGATE\",\"PlatformVersion\":\"1.4.0\"}},\"FargateTaskSetRevisionNumber\":{\"Next\":\"FargateTaskWithPropagatedTag\",\"Type\":\"Task\",\"Resource\":\"arn:",
  {
  "Ref": "AWS::Partition"
  },

packages/@aws-cdk-testing/framework-integ/test/aws-stepfunctions-tasks/test/ecs/integ.fargate-run-task.ts

@@ -57,6 +57,8 @@ const definition = new sfn.Pass(stack, 'Start', {
  platformVersion: ecs.FargatePlatformVersion.VERSION1_4,
  }),
  taskTimeout: sfn.Timeout.at('$.Timeout'),
+ cpu: '1024',
+ memoryMiB: '2048',
  }),
 ).next(
  new tasks.EcsRunTask(stack, 'FargateTaskSetRevisionNumber', {

packages/aws-cdk-lib/aws-stepfunctions-tasks/README.md

@@ -701,6 +701,39 @@ const runTask = new tasks.EcsRunTask(this, 'RunFargate', {
 });
 ```
 
+#### Override CPU and Memory Parameter
+
+By setting the property cpu or memoryMiB, you can override the Fargate or EC2 task instance size at runtime.
+
+see: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskOverride.html
+
+```ts
+const vpc = ec2.Vpc.fromLookup(this, 'Vpc', {
+ isDefault: true,
+});
+const cluster = new ecs.Cluster(this, 'ECSCluster', { vpc });
+
+const taskDefinition = new ecs.TaskDefinition(this, 'TD', {
+ compatibility: ecs.Compatibility.FARGATE,
+ cpu: '256',
+ memoryMiB: '512'
+});
+
+taskDefinition.addContainer('TheContainer', {
+ image: ecs.ContainerImage.fromRegistry('foo/bar'),
+});
+
+const runTask = new tasks.EcsRunTask(this, 'Run', {
+ integrationPattern: sfn.IntegrationPattern.RUN_JOB,
+ cluster,
+ taskDefinition,
+ launchTarget: new tasks.EcsFargateLaunchTarget(),
+ cpu: '1024',
+ memoryMiB: '1048'
+});
+```
+
+
 #### ECS enable Exec
 
 By setting the property [`enableExecuteCommand`](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-enableExecuteCommand) to `true`, you can enable the [ECS Exec feature](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html) for the task for either Fargate or EC2 launch types.

packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/ecs/run-task.ts

@@ -90,6 +90,20 @@ export interface EcsRunTaskProps extends sfn.TaskStateBaseProps {
  * @default false
  */
  readonly enableExecuteCommand?: boolean;
+
+ /**
+ * Cpu setting override
+ * @see https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskOverride.html
+ * @default - No override
+ */
+ readonly cpu?: string;
+
+ /**
+ * Memory setting override
+ * @see https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskOverride.html
+ * @default - No override
+ */
+ readonly memoryMiB?: string;
 }
 
 /**
@@ -310,7 +324,12 @@ export class EcsRunTask extends sfn.TaskStateBase implements ec2.IConnectable {
  Cluster: this.props.cluster.clusterArn,
  TaskDefinition: this.props.revisionNumber === undefined ? this.props.taskDefinition.family : `${this.props.taskDefinition.family}:${this.props.revisionNumber.toString()}`,
  NetworkConfiguration: this.networkConfiguration,
- Overrides: renderOverrides(this.props.containerOverrides),
+ Overrides: renderOverrides(
+ {
+ cpu: this.props.cpu,
+ memoryMiB: this.props.memoryMiB,
+ containerOverrides: this.props.containerOverrides,
+ }),
  PropagateTags: this.props.propagatedTagSource,
  ...this.props.launchTarget.bind(this, { taskDefinition: this.props.taskDefinition, cluster: this.props.cluster }).parameters,
  EnableExecuteCommand: this.props.enableExecuteCommand,
@@ -415,26 +434,40 @@ export class EcsRunTask extends sfn.TaskStateBase implements ec2.IConnectable {
  }
 }
 
-function renderOverrides(containerOverrides?: ContainerOverride[]) {
- if (!containerOverrides || containerOverrides.length === 0) {
+interface OverrideProps {
+ cpu?: string;
+ memoryMiB?: string;
+ containerOverrides?: ContainerOverride[];
+}
+
+function renderOverrides(props: OverrideProps) {
+ const containerOverrides = props.containerOverrides;
+ const noContainerOverrides = !containerOverrides || containerOverrides.length === 0;
+ if (noContainerOverrides && !props.cpu && !props.memoryMiB) {
  return undefined;
  }
 
  const ret = new Array<any>();
- for (const override of containerOverrides) {
- ret.push({
- Name: override.containerDefinition.containerName,
- Command: override.command,
- Cpu: override.cpu,
- Memory: override.memoryLimit,
- MemoryReservation: override.memoryReservation,
- Environment:
- override.environment?.map((e) => ({
- Name: e.name,
- Value: e.value,
- })),
- });
+ if (!noContainerOverrides) {
+ for (const override of containerOverrides) {
+ ret.push({
+ Name: override.containerDefinition.containerName,
+ Command: override.command,
+ Cpu: override.cpu,
+ Memory: override.memoryLimit,
+ MemoryReservation: override.memoryReservation,
+ Environment:
+ override.environment?.map((e) => ({
+ Name: e.name,
+ Value: e.value,
+ })),
+ });
+ }
  }
 
- return { ContainerOverrides: ret };
+ return {
+ Cpu: props.cpu,
+ Memory: props.memoryMiB,
+ ContainerOverrides: noContainerOverrides ? undefined : ret,
+ };
 }

packages/aws-cdk-lib/aws-stepfunctions-tasks/test/ecs/run-tasks.test.ts

@@ -209,6 +209,60 @@ test('Running a task with NONE as propagated tag source', () => {
  }).toStateJson())).toHaveProperty('Parameters.PropagateTags', 'NONE');
 });
 
+test('Running a task with cpu parameter', () => {
+ const taskDefinition = new ecs.TaskDefinition(stack, 'TD', {
+ memoryMiB: '1024',
+ cpu: '512',
+ compatibility: ecs.Compatibility.FARGATE,
+ });
+ const containerDefinition = taskDefinition.addContainer('TheContainer', {
+ containerName: 'ExplicitContainerName',
+ image: ecs.ContainerImage.fromRegistry('foo/bar'),
+ memoryLimitMiB: 256,
+ });
+
+ expect(stack.resolve(
+ new tasks.EcsRunTask(stack, 'task', {
+ cluster,
+ taskDefinition,
+ cpu: '1024',
+ containerOverrides: [
+ {
+ containerDefinition,
+ environment: [{ name: 'SOME_KEY', value: sfn.JsonPath.stringAt('$.SomeKey') }],
+ },
+ ],
+ launchTarget: new tasks.EcsFargateLaunchTarget(),
+ }).toStateJson())).toHaveProperty('Parameters.Overrides.Cpu', '1024');
+});
+
+test('Running a task with memory parameter', () => {
+ const taskDefinition = new ecs.TaskDefinition(stack, 'TD', {
+ memoryMiB: '1024',
+ cpu: '512',
+ compatibility: ecs.Compatibility.FARGATE,
+ });
+ const containerDefinition = taskDefinition.addContainer('TheContainer', {
+ containerName: 'ExplicitContainerName',
+ image: ecs.ContainerImage.fromRegistry('foo/bar'),
+ memoryLimitMiB: 256,
+ });
+
+ expect(stack.resolve(
+ new tasks.EcsRunTask(stack, 'task', {
+ cluster,
+ taskDefinition,
+ memoryMiB: '2048',
+ containerOverrides: [
+ {
+ containerDefinition,
+ environment: [{ name: 'SOME_KEY', value: sfn.JsonPath.stringAt('$.SomeKey') }],
+ },
+ ],
+ launchTarget: new tasks.EcsFargateLaunchTarget(),
+ }).toStateJson())).toHaveProperty('Parameters.Overrides.Memory', '2048');
+});
+
 test('Running a Fargate Task', () => {
  const taskDefinition = new ecs.TaskDefinition(stack, 'TD', {
  memoryMiB: '512',