EcsTask.Builder (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.awscdk.services.events.targets.EcsTask.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<EcsTask>

Enclosing class:: EcsTask

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

A fluent builder for EcsTask.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EcsTask`	`build()`
`EcsTask.Builder`	`cluster(ICluster cluster)` Cluster where service will be deployed.
`EcsTask.Builder`	`containerOverrides(List<? extends ContainerOverride> containerOverrides)` Container setting overrides.
`static EcsTask.Builder`	`create()`
`EcsTask.Builder`	`deadLetterQueue(IQueue deadLetterQueue)` The SQS queue to be used as deadLetterQueue.
`EcsTask.Builder`	`maxEventAge(Duration maxEventAge)` The maximum age of a request that Lambda sends to a function for processing.
`EcsTask.Builder`	`platformVersion(FargatePlatformVersion platformVersion)` The platform version on which to run your task.
`EcsTask.Builder`	`retryAttempts(Number retryAttempts)` The maximum number of times to retry when the function returns an error.
`EcsTask.Builder`	`role(IRole role)` Existing IAM role to run the ECS task.
`EcsTask.Builder`	`securityGroups(List<? extends ISecurityGroup> securityGroups)` Existing security groups to use for the task's ENIs.
`EcsTask.Builder`	`subnetSelection(SubnetSelection subnetSelection)` In what subnets to place the task's ENIs.
`EcsTask.Builder`	`taskCount(Number taskCount)` How many tasks should be started when this event is triggered.
`EcsTask.Builder`	`taskDefinition(ITaskDefinition taskDefinition)` 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=Stable)
public static EcsTask.Builder create()
```
    Returns:
    
    a new instance of EcsTask.Builder.
  - deadLetterQueue
```
@Stability(value=Stable)
public EcsTask.Builder deadLetterQueue(IQueue 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.
    Default: - no dead-letter queue
    
    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). This parameter is required.
    
    Returns:
    
    this
  - maxEventAge
```
@Stability(value=Stable)
public EcsTask.Builder maxEventAge(Duration maxEventAge)
```
    The maximum age of a request that Lambda sends to a function for processing.
    Minimum value of 60. Maximum value of 86400.
    Default: Duration.hours(24)
    
    Parameters:
    
    maxEventAge - The maximum age of a request that Lambda sends to a function for processing. This parameter is required.
    
    Returns:
    
    this
  - retryAttempts
```
@Stability(value=Stable)
public EcsTask.Builder retryAttempts(Number retryAttempts)
```
    The maximum number of times to retry when the function returns an error.
    Minimum value of 0. Maximum value of 185.
    Default: 185
    
    Parameters:
    
    retryAttempts - The maximum number of times to retry when the function returns an error. This parameter is required.
    
    Returns:
    
    this
  - cluster
```
@Stability(value=Stable)
public EcsTask.Builder cluster(ICluster cluster)
```
    Cluster where service will be deployed.
    
    Parameters:
    
    cluster - Cluster where service will be deployed. This parameter is required.
    
    Returns:
    
    this
  - taskDefinition
```
@Stability(value=Stable)
public EcsTask.Builder taskDefinition(ITaskDefinition taskDefinition)
```
    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=Stable)
public EcsTask.Builder containerOverrides(List<? extends ContainerOverride> containerOverrides)
```
    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=Stable)
public EcsTask.Builder platformVersion(FargatePlatformVersion platformVersion)
```
    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=Stable)
public EcsTask.Builder role(IRole role)
```
    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=Stable)
public EcsTask.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)
```
    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=Stable)
public EcsTask.Builder subnetSelection(SubnetSelection subnetSelection)
```
    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=Stable)
public EcsTask.Builder taskCount(Number taskCount)
```
    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=Stable)
public EcsTask build()
```
    Specified by:
    
    build in interface software.amazon.jsii.Builder<EcsTask>

Class EcsTask.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

deadLetterQueue

maxEventAge

retryAttempts

cluster

taskDefinition

containerOverrides

platformVersion

role

securityGroups

subnetSelection

taskCount

build