Package software.amazon.awscdk.services.stepfunctions.tasks

Interface EcsRunTaskProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

All Known Implementing Classes:

EcsRunTaskProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-15T21:09:27.955Z")
@Stability(Stable)
public interface EcsRunTaskProps
extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

Properties for ECS Tasks.

Example:

 IVpc vpc = Vpc.fromLookup(this, "Vpc", VpcLookupOptions.builder()
         .isDefault(true)
         .build());
 Cluster cluster = Cluster.Builder.create(this, "FargateCluster").vpc(vpc).build();
 TaskDefinition taskDefinition = TaskDefinition.Builder.create(this, "TD")
         .memoryMiB("512")
         .cpu("256")
         .compatibility(Compatibility.FARGATE)
         .build();
 ContainerDefinition containerDefinition = taskDefinition.addContainer("TheContainer", ContainerDefinitionOptions.builder()
         .image(ContainerImage.fromRegistry("foo/bar"))
         .memoryLimitMiB(256)
         .build());
 EcsRunTask runTask = EcsRunTask.Builder.create(this, "RunFargate")
         .integrationPattern(IntegrationPattern.RUN_JOB)
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .assignPublicIp(true)
         .containerOverrides(List.of(ContainerOverride.builder()
                 .containerDefinition(containerDefinition)
                 .environment(List.of(TaskEnvironmentVariable.builder().name("SOME_KEY").value(JsonPath.stringAt("$.SomeKey")).build()))
                 .build()))
         .launchTarget(new EcsFargateLaunchTarget())
         .propagatedTagSource(PropagatedTagSource.TASK_DEFINITION)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	EcsRunTaskProps.Builder	A builder for EcsRunTaskProps
static final class	EcsRunTaskProps.Jsii$Proxy	An implementation for EcsRunTaskProps

Method Summary

Modifier and Type	Method	Description
static EcsRunTaskProps.Builder	builder()
default Boolean	getAssignPublicIp()	Assign public IP addresses to each task.
ICluster	getCluster()	The ECS cluster to run the task on.
default List<ContainerOverride>	getContainerOverrides()	Container setting overrides.
default String	getCpu()	Cpu setting override.
default Boolean	getEnableExecuteCommand()	Whether ECS Exec should be enabled.
IEcsLaunchTarget	getLaunchTarget()	An Amazon ECS launch type determines the type of infrastructure on which your tasks and services are hosted.
default String	getMemoryMiB()	Memory setting override.
default PropagatedTagSource	getPropagatedTagSource()	Specifies whether to propagate the tags from the task definition to the task.
default Number	getRevisionNumber()	The revision number of ECS task definition family.
default List<ISecurityGroup>	getSecurityGroups()	Existing security groups to use for the tasks.
default SubnetSelection	getSubnets()	Subnets to place the task's ENIs.
TaskDefinition	getTaskDefinition()	[disable-awslint:ref-via-interface] Task Definition used for running tasks in the service.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps

getComment, getCredentials, getHeartbeat, getHeartbeatTimeout, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getStateName, getTaskTimeout, getTimeout

Method Details

getCluster

@Stability(Stable)
@NotNull
ICluster getCluster()

The ECS cluster to run the task on.

getLaunchTarget

@Stability(Stable)
@NotNull
IEcsLaunchTarget getLaunchTarget()

An Amazon ECS launch type determines the type of infrastructure on which your tasks and services are hosted.

See Also:

• https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html

getTaskDefinition

@Stability(Stable)
@NotNull
TaskDefinition getTaskDefinition()

[disable-awslint:ref-via-interface] 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

getAssignPublicIp

@Stability(Stable)
@Nullable
default Boolean getAssignPublicIp()

Assign public IP addresses to each task.

Default: false

getContainerOverrides

@Stability(Stable)
@Nullable
default List<ContainerOverride> getContainerOverrides()

Container setting overrides.

Specify the container to use and the overrides to apply.

Default: - No overrides

getCpu

@Stability(Stable)
@Nullable
default String getCpu()

Cpu setting override.

Default: - No override

See Also:

• https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskOverride.html

getEnableExecuteCommand

@Stability(Stable)
@Nullable
default Boolean getEnableExecuteCommand()

Whether ECS Exec should be enabled.

Default: false

See Also:

• https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-enableExecuteCommand

getMemoryMiB

@Stability(Stable)
@Nullable
default String getMemoryMiB()

Memory setting override.

Default: - No override

See Also:

• https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TaskOverride.html

getPropagatedTagSource

@Stability(Stable)
@Nullable
default PropagatedTagSource getPropagatedTagSource()

Specifies whether to propagate the tags from the task definition to the task.

An error will be received if you specify the SERVICE option when running a task.

Default: - No tags are propagated.

See Also:

• https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-propagateTags

getRevisionNumber

@Stability(Stable)
@Nullable
default Number getRevisionNumber()

The revision number of ECS task definition family.

Default: - '$latest'

getSecurityGroups

@Stability(Stable)
@Nullable
default List<ISecurityGroup> getSecurityGroups()

Existing security groups to use for the tasks.

Default: - A new security group is created

getSubnets

@Stability(Stable)
@Nullable
default SubnetSelection getSubnets()

Subnets to place the task's ENIs.

Default: - Public subnets if assignPublicIp is set. Private subnets otherwise.

builder

@Stability(Stable)
static EcsRunTaskProps.Builder builder()

Returns:

a EcsRunTaskProps.Builder of EcsRunTaskProps