software.amazon.awscdk.services.events.targets

Interface EcsTaskProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TargetBaseProps

All Known Implementing Classes:

EcsTaskProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.325Z")
 @Stability(value=Stable)
public interface EcsTaskProps
extends software.amazon.jsii.JsiiSerializable, TargetBaseProps

Properties to define an ECS Event Task.

Example:

 import software.amazon.awscdk.services.events.Rule;
 import software.amazon.awscdk.services.events.Schedule;
 import software.amazon.awscdk.services.events.targets.EcsTask;
 import software.amazon.awscdk.services.ecs.Cluster;
 import software.amazon.awscdk.services.ecs.TaskDefinition;
 import software.amazon.awscdk.services.iam.Role;
 Cluster cluster;
 TaskDefinition taskDefinition;
 Role role;
 EcsTask ecsTaskTarget = EcsTask.Builder.create().cluster(cluster).taskDefinition(taskDefinition).role(role).build();
 Rule.Builder.create(this, "ScheduleRule")
         .schedule(Schedule.cron(CronOptions.builder().minute("0").hour("4").build()))
         .targets(List.of(ecsTaskTarget))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static EcsTaskProps.Builder	builder()
ICluster	getCluster() Cluster where service will be deployed.
default List<ContainerOverride>	getContainerOverrides() Container setting overrides.
default FargatePlatformVersion	getPlatformVersion() The platform version on which to run your task.
default IRole	getRole() Existing IAM role to run the ECS task.
default List<ISecurityGroup>	getSecurityGroups() Existing security groups to use for the task's ENIs.
default SubnetSelection	getSubnetSelection() In what subnets to place the task's ENIs.
default Number	getTaskCount() How many tasks should be started when this event is triggered.
ITaskDefinition	getTaskDefinition() Task Definition of the task that should be started.

Methods inherited from interface software.amazon.awscdk.services.events.targets.TargetBaseProps

getDeadLetterQueue, getMaxEventAge, getRetryAttempts

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCluster

@Stability(value=Stable)
 @NotNull
ICluster getCluster()

Cluster where service will be deployed.

getTaskDefinition

@Stability(value=Stable)
 @NotNull
ITaskDefinition getTaskDefinition()

Task Definition of the task that should be started.

getContainerOverrides

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

Container setting overrides.

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

getPlatformVersion

@Stability(value=Stable)
 @Nullable
default FargatePlatformVersion getPlatformVersion()

The platform version on which to run your task.

Unless you have specific compatibility requirements, you don't need to specify this.

Default: - ECS will set the Fargate platform version to 'LATEST'

See Also:

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

getRole

@Stability(value=Stable)
 @Nullable
default IRole getRole()

Existing IAM role to run the ECS task.

Default: A new IAM role is created

getSecurityGroups

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

Existing security groups to use for the task's ENIs.

(Only applicable in case the TaskDefinition is configured for AwsVpc networking)

Default: A new security group is created

getSubnetSelection

@Stability(value=Stable)
 @Nullable
default SubnetSelection getSubnetSelection()

In what subnets to place the task's ENIs.

(Only applicable in case the TaskDefinition is configured for AwsVpc networking)

Default: Private subnets

getTaskCount

@Stability(value=Stable)
 @Nullable
default Number getTaskCount()

How many tasks should be started when this event is triggered.

Default: 1

builder

@Stability(value=Stable)
static EcsTaskProps.Builder builder()

Specified by:

builder in interface TargetBaseProps

Returns:

a EcsTaskProps.Builder of EcsTaskProps