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.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:47.964Z")
@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, "Ec2Cluster").vpc(vpc).build();
 cluster.addCapacity("DefaultAutoScalingGroup", AddCapacityOptions.builder()
         .instanceType(new InstanceType("t2.micro"))
         .vpcSubnets(SubnetSelection.builder().subnetType(SubnetType.PUBLIC).build())
         .build());
 TaskDefinition taskDefinition = TaskDefinition.Builder.create(this, "TD")
         .compatibility(Compatibility.EC2)
         .build();
 taskDefinition.addContainer("TheContainer", ContainerDefinitionOptions.builder()
         .image(ContainerImage.fromRegistry("foo/bar"))
         .memoryLimitMiB(256)
         .build());
 EcsRunTask runTask = EcsRunTask.Builder.create(this, "Run")
         .integrationPattern(IntegrationPattern.RUN_JOB)
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .launchTarget(EcsEc2LaunchTarget.Builder.create()
                 .placementStrategies(List.of(PlacementStrategy.spreadAcrossInstances(), PlacementStrategy.packedByCpu(), PlacementStrategy.randomly()))
                 .placementConstraints(List.of(PlacementConstraint.memberOf("blieptuut")))
                 .build())
         .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.
IEcsLaunchTarget	getLaunchTarget()	An Amazon ECS launch type determines the type of infrastructure on which your tasks and services are hosted.
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, getHeartbeat, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, 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

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

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