Skip to content
v2.273.0

CommonEcsRunTaskProps Struct ​

Basic properties for ECS Tasks.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ecs as ecs } from 'aws-cdk-lib';
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';

declare const cluster: ecs.Cluster;
declare const containerDefinition: ecs.ContainerDefinition;
declare const taskDefinition: ecs.TaskDefinition;
const commonEcsRunTaskProps: stepfunctions_tasks.CommonEcsRunTaskProps = {
  cluster: cluster,
  taskDefinition: taskDefinition,

  // the properties below are optional
  containerOverrides: [{
    containerDefinition: containerDefinition,

    // the properties below are optional
    command: ['command'],
    cpu: 123,
    environment: [{
      name: 'name',
      value: 'value',
    }],
    memoryLimit: 123,
    memoryReservation: 123,
  }],
  integrationPattern: stepfunctions.ServiceIntegrationPattern.FIRE_AND_FORGET,
};

Properties ​

clusterIClusterclusterIClusterclusterIClusterClusterIClusterClusterIClusterrequired#
The topic to run the task on.
containerOverridesContainerOverride[]container_overridestyping.List[ContainerOverride]containerOverridesList<ContainerOverride>ContainerOverridesContainerOverride[]ContainerOverrides*[]ContainerOverride= No overrides#
Container setting overrides.

Key is the name of the container to override, value is the values you want to override.

integrationPatternServiceIntegrationPatternintegration_patternServiceIntegrationPatternintegrationPatternServiceIntegrationPatternIntegrationPatternServiceIntegrationPatternIntegrationPatternServiceIntegrationPattern= FIRE_AND_FORGET#
The service integration pattern indicates different ways to call RunTask in ECS.

The valid value for Lambda is FIRE_AND_FORGET, SYNC and WAIT_FOR_TASK_TOKEN.

taskDefinitionTaskDefinitiontask_definitionTaskDefinitiontaskDefinitionTaskDefinitionTaskDefinitionTaskDefinitionTaskDefinitionTaskDefinitionrequired#
Task Definition used for running tasks in the service.

Note: this must be TaskDefinition, and not ITaskDefinition, as it requires properties that are not known for imported task definitions If you want to run a RunTask with an imported task definition, consider using CustomState