aws-cdk-lib.aws_stepfunctions_tasks.CommonEcsRunTaskProps

interface CommonEcsRunTaskProps

LanguageType name
.NETAmazon.CDK.AWS.StepFunctions.Tasks.CommonEcsRunTaskProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#CommonEcsRunTaskProps
Javasoftware.amazon.awscdk.services.stepfunctions.tasks.CommonEcsRunTaskProps
Pythonaws_cdk.aws_stepfunctions_tasks.CommonEcsRunTaskProps
TypeScript (source)aws-cdk-lib » 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 { 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

NameTypeDescription
clusterIClusterThe topic to run the task on.
taskDefinitionTaskDefinitionTask Definition used for running tasks in the service.
containerOverrides?ContainerOverride[]Container setting overrides.
integrationPattern?ServiceIntegrationPatternThe 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 If you want to run a RunTask with an imported task definition, consider using CustomState


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.