software.amazon.awscdk.services.events.targets

Class EcsTaskProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<EcsTaskProps>

Enclosing interface:

EcsTaskProps

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

A builder for EcsTaskProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
EcsTaskProps	build() Builds the configured instance.
EcsTaskProps.Builder	cluster(ICluster cluster) Sets the value of EcsTaskProps.getCluster()
EcsTaskProps.Builder	containerOverrides(List<? extends ContainerOverride> containerOverrides) Sets the value of EcsTaskProps.getContainerOverrides()
EcsTaskProps.Builder	deadLetterQueue(IQueue deadLetterQueue) Sets the value of TargetBaseProps.getDeadLetterQueue()
EcsTaskProps.Builder	maxEventAge(Duration maxEventAge) Sets the value of TargetBaseProps.getMaxEventAge()
EcsTaskProps.Builder	platformVersion(FargatePlatformVersion platformVersion) Sets the value of EcsTaskProps.getPlatformVersion()
EcsTaskProps.Builder	retryAttempts(Number retryAttempts) Sets the value of TargetBaseProps.getRetryAttempts()
EcsTaskProps.Builder	role(IRole role) Sets the value of EcsTaskProps.getRole()
EcsTaskProps.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups) Sets the value of EcsTaskProps.getSecurityGroups()
EcsTaskProps.Builder	subnetSelection(SubnetSelection subnetSelection) Sets the value of EcsTaskProps.getSubnetSelection()
EcsTaskProps.Builder	taskCount(Number taskCount) Sets the value of EcsTaskProps.getTaskCount()
EcsTaskProps.Builder	taskDefinition(ITaskDefinition taskDefinition) Sets the value of EcsTaskProps.getTaskDefinition()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

cluster

@Stability(value=Stable)
public EcsTaskProps.Builder cluster(ICluster cluster)

Sets the value of EcsTaskProps.getCluster()

Parameters:

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

Returns:

this

taskDefinition

@Stability(value=Stable)
public EcsTaskProps.Builder taskDefinition(ITaskDefinition taskDefinition)

Sets the value of EcsTaskProps.getTaskDefinition()

Parameters:

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

Returns:

this

containerOverrides

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

Sets the value of EcsTaskProps.getContainerOverrides()

Parameters:

containerOverrides - Container setting overrides. Key is the name of the container to override, value is the values you want to override.

Returns:

this

platformVersion

@Stability(value=Stable)
public EcsTaskProps.Builder platformVersion(FargatePlatformVersion platformVersion)

Sets the value of EcsTaskProps.getPlatformVersion()

Parameters:

platformVersion - The platform version on which to run your task. Unless you have specific compatibility requirements, you don't need to specify this.

Returns:

this

role

@Stability(value=Stable)
public EcsTaskProps.Builder role(IRole role)

Sets the value of EcsTaskProps.getRole()

Parameters:

role - Existing IAM role to run the ECS task.

Returns:

this

securityGroups

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

Sets the value of EcsTaskProps.getSecurityGroups()

Parameters:

securityGroups - Existing security groups to use for the task's ENIs. (Only applicable in case the TaskDefinition is configured for AwsVpc networking)

Returns:

this

subnetSelection

@Stability(value=Stable)
public EcsTaskProps.Builder subnetSelection(SubnetSelection subnetSelection)

Sets the value of EcsTaskProps.getSubnetSelection()

Parameters:

subnetSelection - In what subnets to place the task's ENIs. (Only applicable in case the TaskDefinition is configured for AwsVpc networking)

Returns:

this

taskCount

@Stability(value=Stable)
public EcsTaskProps.Builder taskCount(Number taskCount)

Sets the value of EcsTaskProps.getTaskCount()

Parameters:

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

Returns:

this

deadLetterQueue

@Stability(value=Stable)
public EcsTaskProps.Builder deadLetterQueue(IQueue deadLetterQueue)

Sets the value of TargetBaseProps.getDeadLetterQueue()

Parameters:

deadLetterQueue - The SQS queue to be used as deadLetterQueue. Check out the [considerations for using a dead-letter queue](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-considerations). The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue.

Returns:

this

maxEventAge

@Stability(value=Stable)
public EcsTaskProps.Builder maxEventAge(Duration maxEventAge)

Sets the value of TargetBaseProps.getMaxEventAge()

Parameters:

maxEventAge - The maximum age of a request that Lambda sends to a function for processing. Minimum value of 60. Maximum value of 86400.

Returns:

this

retryAttempts

@Stability(value=Stable)
public EcsTaskProps.Builder retryAttempts(Number retryAttempts)

Sets the value of TargetBaseProps.getRetryAttempts()

Parameters:

retryAttempts - The maximum number of times to retry when the function returns an error. Minimum value of 0. Maximum value of 185.

Returns:

this

build

@Stability(value=Stable)
public EcsTaskProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of EcsTaskProps

Throws:

NullPointerException - if any required attribute was not provided