software.amazon.awscdk.services.events.targets

Class EcsTask.Builder

java.lang.Object

software.amazon.awscdk.services.events.targets.EcsTask.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EcsTask>

Enclosing class:

EcsTask

@Stability(value=Experimental)
public static final class EcsTask.Builder
extends Object
implements software.amazon.jsii.Builder<EcsTask>

(experimental) A fluent builder for EcsTask.

Method Summary

Modifier and Type	Method and Description
EcsTask	build()
EcsTask.Builder	cluster(ICluster cluster) (experimental) Cluster where service will be deployed.
EcsTask.Builder	containerOverrides(List<? extends ContainerOverride> containerOverrides) (experimental) Container setting overrides.
static EcsTask.Builder	create()
EcsTask.Builder	platformVersion(FargatePlatformVersion platformVersion) (experimental) The platform version on which to run your task.
EcsTask.Builder	role(IRole role) (experimental) Existing IAM role to run the ECS task.
EcsTask.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups) (experimental) Existing security groups to use for the task's ENIs.
EcsTask.Builder	subnetSelection(SubnetSelection subnetSelection) (experimental) In what subnets to place the task's ENIs.
EcsTask.Builder	taskCount(Number taskCount) (experimental) How many tasks should be started when this event is triggered.
EcsTask.Builder	taskDefinition(ITaskDefinition taskDefinition) (experimental) Task Definition of the task that should be started.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Experimental)
public static EcsTask.Builder create()

Returns:

a new instance of EcsTask.Builder.

cluster

@Stability(value=Experimental)
public EcsTask.Builder cluster(ICluster cluster)

(experimental) Cluster where service will be deployed.

Parameters:

cluster - Cluster where service will be deployed. This parameter is required.

Returns:

this

taskDefinition

@Stability(value=Experimental)
public EcsTask.Builder taskDefinition(ITaskDefinition taskDefinition)

(experimental) Task Definition of the task that should be started.

Parameters:

taskDefinition - Task Definition of the task that should be started. This parameter is required.

Returns:

this

containerOverrides

@Stability(value=Experimental)
public EcsTask.Builder containerOverrides(List<? extends ContainerOverride> containerOverrides)

(experimental) Container setting overrides.

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

Parameters:

containerOverrides - Container setting overrides. This parameter is required.

Returns:

this

platformVersion

@Stability(value=Experimental)
public EcsTask.Builder platformVersion(FargatePlatformVersion platformVersion)

(experimental) 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'

Parameters:

platformVersion - The platform version on which to run your task. This parameter is required.

Returns:

this

See Also:

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

role

@Stability(value=Experimental)
public EcsTask.Builder role(IRole role)

(experimental) Existing IAM role to run the ECS task.

Default: A new IAM role is created

Parameters:

role - Existing IAM role to run the ECS task. This parameter is required.

Returns:

this

securityGroups

@Stability(value=Experimental)
public EcsTask.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)

(experimental) 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

Parameters:

securityGroups - Existing security groups to use for the task's ENIs. This parameter is required.

Returns:

this

subnetSelection

@Stability(value=Experimental)
public EcsTask.Builder subnetSelection(SubnetSelection subnetSelection)

(experimental) In what subnets to place the task's ENIs.

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

Default: Private subnets

Parameters:

subnetSelection - In what subnets to place the task's ENIs. This parameter is required.

Returns:

this

taskCount

@Stability(value=Experimental)
public EcsTask.Builder taskCount(Number taskCount)

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

Default: 1

Parameters:

taskCount - How many tasks should be started when this event is triggered. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public EcsTask build()

Specified by:

build in interface software.amazon.jsii.Builder<EcsTask>