(aws-scheduler-targets): Add containerOverrides to props of EcsRunFargateTask / EcsRunTask

[eggplants]

Describe the feature

I would like to specify containerOverrides in props of EcsRunFargateTask.

Use Case

It allows the creation of multiple schedules with different arguments from a single task definition.

Proposed Solution

Like aws_stepfunctions_tasks.ContainerOverrides

import * as scheduler from 'aws-cdk-lib/aws-scheduler'
import * as schedulerTargets from 'aws-cdk-lib/aws-scheduler-targets'
new scheduler.Schedule(this, `${taskConfig.name}Schedule`, {
  schedule: scheduler.ScheduleExpression.expression(taskConfig.scheduleExpression),
  target: new schedulerTargets.EcsRunFargateTask(ecsCluster, {
    taskDefinition,
    containerOverrides: {command: [taskConfig.name]}
  }),
})

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

CDK version used

2.1007.0 (build d3f6c3c)

Environment details (OS name and version, etc.)

Mac

[eggplants]

Workaround:

import * as scheduler from 'aws-cdk-lib/aws-scheduler'
import * as schedulerTargets from 'aws-cdk-lib/aws-scheduler-targets'
new scheduler.Schedule(this, `${taskConfig.name}Schedule`, {
  schedule: scheduler.ScheduleExpression.expression(taskConfig.scheduleExpression),
  target: new schedulerTargets.EcsRunFargateTask(ecsCluster, {
    taskDefinition,
    input: scheduler.ScheduleTargetInput.fromObject({
      containerOverrides: [{command: [serviceName]}],
    }),
  }),
})

[ykethan]

Hey @eggplants, 👋 thank you for filing this issue. It does appear aws-scheduler-targets module currently lacks a direct way to specify container overrides for ECS tasks.
On reviewing the packages/aws-cdk-lib/aws-scheduler-targets/lib/ecs-run-task.ts, this file contains the EcsRunFargateTask and EcsRunEc2Task classes that would need to be updated to include the containerOverrides property.

From the top of my mind similar to the aws-stepfunctions-tasks module we could implement ContainerOverride interface in the aws-scheduler-targets module.

Then add the containerOverrides property to the EcsRunTaskBaseProps interface:

export interface EcsRunTaskBaseProps extends ScheduleTargetBaseProps {
  // Existing properties...
  
  /**
   * Container setting overrides
   *
   * Key is the name of the container to override, value is the
   * values you want to override.
   *
   * @default - No overrides
   */
  readonly containerOverrides?: ContainerOverride[];
}

Update the bindBaseTargetConfig method in the EcsRunTask class to include the container overrides in the target configuration:

protected bindBaseTargetConfig(_schedule: ISchedule): ScheduleTargetConfig {
  // Existing code...
  
  return {
    ...super.bindBaseTargetConfig(_schedule),
    ecsParameters: {
      // Add container overrides if specified
      containerOverrides: this.props.containerOverrides ? renderContainerOverrides(this.props.containerOverrides) : undefined,
      // Other parameters...
    },
  };
}

But leave it to the team to dive into this implementation. we do accept new pull requests on this repository as well.