EcsRunTask.Builder (software.amazon.awscdk:stepfunctions-tasks 1.187.0 API)

java.lang.Object
- software.amazon.awscdk.services.stepfunctions.tasks.EcsRunTask.Builder

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

Enclosing class:: EcsRunTask

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

A fluent builder for EcsRunTask.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EcsRunTask.Builder`	`assignPublicIp(Boolean assignPublicIp)` Assign public IP addresses to each task.
`EcsRunTask`	`build()`
`EcsRunTask.Builder`	`cluster(ICluster cluster)` The ECS cluster to run the task on.
`EcsRunTask.Builder`	`comment(String comment)` An optional description for this state.
`EcsRunTask.Builder`	`containerOverrides(List<? extends ContainerOverride> containerOverrides)` Container setting overrides.
`static EcsRunTask.Builder`	`create(software.constructs.Construct scope, String id)`
`EcsRunTask.Builder`	`heartbeat(Duration heartbeat)` Timeout for the heartbeat.
`EcsRunTask.Builder`	`inputPath(String inputPath)` JSONPath expression to select part of the state to be the input to this state.
`EcsRunTask.Builder`	`integrationPattern(IntegrationPattern integrationPattern)` AWS Step Functions integrates with services directly in the Amazon States Language.
`EcsRunTask.Builder`	`launchTarget(IEcsLaunchTarget launchTarget)` An Amazon ECS launch type determines the type of infrastructure on which your tasks and services are hosted.
`EcsRunTask.Builder`	`outputPath(String outputPath)` JSONPath expression to select select a portion of the state output to pass to the next state.
`EcsRunTask.Builder`	`resultPath(String resultPath)` JSONPath expression to indicate where to inject the state's output.
`EcsRunTask.Builder`	`resultSelector(Map<String,? extends Object> resultSelector)` The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
`EcsRunTask.Builder`	`securityGroups(List<? extends ISecurityGroup> securityGroups)` Existing security groups to use for the tasks.
`EcsRunTask.Builder`	`subnets(SubnetSelection subnets)` Subnets to place the task's ENIs.
`EcsRunTask.Builder`	`taskDefinition(TaskDefinition taskDefinition)` [disable-awslint:ref-via-interface] Task Definition used for running tasks in the service.
`EcsRunTask.Builder`	`timeout(Duration timeout)` Timeout for the state machine.

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 EcsRunTask.Builder create(software.constructs.Construct scope,
                                                                 String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of EcsRunTask.Builder.
  - comment
```
@Stability(value=Stable)
public EcsRunTask.Builder comment(String comment)
```
    An optional description for this state.
    Default: - No comment
    
    Parameters:
    
    comment - An optional description for this state. This parameter is required.
    
    Returns:
    
    this
  - heartbeat
```
@Stability(value=Stable)
public EcsRunTask.Builder heartbeat(Duration heartbeat)
```
    Timeout for the heartbeat.
    Default: - None
    
    Parameters:
    
    heartbeat - Timeout for the heartbeat. This parameter is required.
    
    Returns:
    
    this
  - inputPath
```
@Stability(value=Stable)
public EcsRunTask.Builder inputPath(String inputPath)
```
    JSONPath expression to select part of the state to be the input to this state.
    May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
    Default: - The entire task input (JSON path '$')
    
    Parameters:
    
    inputPath - JSONPath expression to select part of the state to be the input to this state. This parameter is required.
    
    Returns:
    
    this
  - integrationPattern
```
@Stability(value=Stable)
public EcsRunTask.Builder integrationPattern(IntegrationPattern integrationPattern)
```
    AWS Step Functions integrates with services directly in the Amazon States Language.
    You can control these AWS services using service integration patterns
    Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.
    
    Parameters:
    
    integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
  - outputPath
```
@Stability(value=Stable)
public EcsRunTask.Builder outputPath(String outputPath)
```
    JSONPath expression to select select a portion of the state output to pass to the next state.
    May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
    Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')
    
    Parameters:
    
    outputPath - JSONPath expression to select select a portion of the state output to pass to the next state. This parameter is required.
    
    Returns:
    
    this
  - resultPath
```
@Stability(value=Stable)
public EcsRunTask.Builder resultPath(String resultPath)
```
    JSONPath expression to indicate where to inject the state's output.
    May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
    Default: - Replaces the entire input with the result (JSON path '$')
    
    Parameters:
    
    resultPath - JSONPath expression to indicate where to inject the state's output. This parameter is required.
    
    Returns:
    
    this
  - resultSelector
```
@Stability(value=Stable)
public EcsRunTask.Builder resultSelector(Map<String,? extends Object> resultSelector)
```
    The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
    You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
    Default: - None
    
    Parameters:
    
    resultSelector - The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector
  - timeout
```
@Stability(value=Stable)
public EcsRunTask.Builder timeout(Duration timeout)
```
    Timeout for the state machine.
    Default: - None
    
    Parameters:
    
    timeout - Timeout for the state machine. This parameter is required.
    
    Returns:
    
    this
  - cluster
```
@Stability(value=Stable)
public EcsRunTask.Builder cluster(ICluster cluster)
```
    The ECS cluster to run the task on.
    
    Parameters:
    
    cluster - The ECS cluster to run the task on. This parameter is required.
    
    Returns:
    
    this
  - launchTarget
```
@Stability(value=Stable)
public EcsRunTask.Builder launchTarget(IEcsLaunchTarget launchTarget)
```
    An Amazon ECS launch type determines the type of infrastructure on which your tasks and services are hosted.
    
    Parameters:
    
    launchTarget - An Amazon ECS launch type determines the type of infrastructure on which your tasks and services are hosted. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html
  - taskDefinition
```
@Stability(value=Stable)
public EcsRunTask.Builder taskDefinition(TaskDefinition taskDefinition)
```
    [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
    
    Parameters:
    
    taskDefinition - [disable-awslint:ref-via-interface] Task Definition used for running tasks in the service. This parameter is required.
    
    Returns:
    
    this
  - assignPublicIp
```
@Stability(value=Stable)
public EcsRunTask.Builder assignPublicIp(Boolean assignPublicIp)
```
    Assign public IP addresses to each task.
    Default: false
    
    Parameters:
    
    assignPublicIp - Assign public IP addresses to each task. This parameter is required.
    
    Returns:
    
    this
  - containerOverrides
```
@Stability(value=Stable)
public EcsRunTask.Builder containerOverrides(List<? extends ContainerOverride> containerOverrides)
```
    Container setting overrides.
    Specify the container to use and the overrides to apply.
    Default: - No overrides
    
    Parameters:
    
    containerOverrides - Container setting overrides. This parameter is required.
    
    Returns:
    
    this
  - securityGroups
```
@Stability(value=Stable)
public EcsRunTask.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)
```
    Existing security groups to use for the tasks.
    Default: - A new security group is created
    
    Parameters:
    
    securityGroups - Existing security groups to use for the tasks. This parameter is required.
    
    Returns:
    
    this
  - subnets
```
@Stability(value=Stable)
public EcsRunTask.Builder subnets(SubnetSelection subnets)
```
    Subnets to place the task's ENIs.
    Default: - Public subnets if assignPublicIp is set. Private subnets otherwise.
    
    Parameters:
    
    subnets - Subnets to place the task's ENIs. This parameter is required.
    
    Returns:
    
    this
  - build
```
@Stability(value=Stable)
public EcsRunTask build()
```
    Specified by:
    
    build in interface software.amazon.jsii.Builder<EcsRunTask>

Class EcsRunTask.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

comment

heartbeat

inputPath

integrationPattern

outputPath

resultPath

resultSelector

timeout

cluster

launchTarget

taskDefinition

assignPublicIp

containerOverrides

securityGroups

subnets

build