interface CommonEcsRunTaskProps

Language	Type name
.NET	Amazon.CDK.AWS.StepFunctions.Tasks.CommonEcsRunTaskProps
Java	software.amazon.awscdk.services.stepfunctions.tasks.CommonEcsRunTaskProps
Python	aws_cdk.aws_stepfunctions_tasks.CommonEcsRunTaskProps
TypeScript (source)	@aws-cdk/aws-stepfunctions-tasks » CommonEcsRunTaskProps

Basic properties for ECS Tasks.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ecs from '@aws-cdk/aws-ecs';
import * as stepfunctions from '@aws-cdk/aws-stepfunctions';
import * as stepfunctions_tasks from '@aws-cdk/aws-stepfunctions-tasks';

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

Name	Type	Description
cluster	ICluster	The topic to run the task on.
taskDefinition	TaskDefinition	Task Definition used for running tasks in the service.
containerOverrides?	ContainerOverride[]	Container setting overrides.
integrationPattern?	ServiceIntegrationPattern	The service integration pattern indicates different ways to call RunTask in ECS.

---

cluster

Type: ICluster

The topic to run the task on.

---

taskDefinition

Type: TaskDefinition

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

---

containerOverrides?

Type: ContainerOverride[] (optional, default: No overrides)

Container setting overrides.

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

---

integrationPattern?

Type: ServiceIntegrationPattern (optional, default: 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.