Package software.amazon.awscdk.services.stepfunctions.tasks

Class EcsRunTaskProps.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.tasks.EcsRunTaskProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EcsRunTaskProps>

Enclosing interface:

EcsRunTaskProps

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

A builder for EcsRunTaskProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EcsRunTaskProps.Builder	assign(Map<String,? extends Object> assign)	Sets the value of AssignableStateOptions.getAssign()
EcsRunTaskProps.Builder	assignPublicIp(Boolean assignPublicIp)	Sets the value of EcsRunTaskProps.getAssignPublicIp()
EcsRunTaskProps	build()	Builds the configured instance.
EcsRunTaskProps.Builder	cluster(ICluster cluster)	Sets the value of EcsRunTaskProps.getCluster()
EcsRunTaskProps.Builder	comment(String comment)	Sets the value of StateBaseProps.getComment()
EcsRunTaskProps.Builder	containerOverrides(List<? extends ContainerOverride> containerOverrides)	Sets the value of EcsRunTaskProps.getContainerOverrides()
EcsRunTaskProps.Builder	cpu(String cpu)	Sets the value of EcsRunTaskProps.getCpu()
EcsRunTaskProps.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseOptions.getCredentials()
EcsRunTaskProps.Builder	enableExecuteCommand(Boolean enableExecuteCommand)	Sets the value of EcsRunTaskProps.getEnableExecuteCommand()
EcsRunTaskProps.Builder	heartbeat(Duration heartbeat)	Deprecated. use `heartbeatTimeout`
EcsRunTaskProps.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()
EcsRunTaskProps.Builder	inputPath(String inputPath)	Sets the value of JsonPathCommonOptions.getInputPath()
EcsRunTaskProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseOptions.getIntegrationPattern()
EcsRunTaskProps.Builder	launchTarget(IEcsLaunchTarget launchTarget)	Sets the value of EcsRunTaskProps.getLaunchTarget()
EcsRunTaskProps.Builder	memoryMiB(String memoryMiB)	Sets the value of EcsRunTaskProps.getMemoryMiB()
EcsRunTaskProps.Builder	outputPath(String outputPath)	Sets the value of JsonPathCommonOptions.getOutputPath()
EcsRunTaskProps.Builder	outputs(Object outputs)	Sets the value of JsonataCommonOptions.getOutputs()
EcsRunTaskProps.Builder	propagatedTagSource(PropagatedTagSource propagatedTagSource)	Sets the value of EcsRunTaskProps.getPropagatedTagSource()
EcsRunTaskProps.Builder	queryLanguage(QueryLanguage queryLanguage)	Sets the value of StateBaseProps.getQueryLanguage()
EcsRunTaskProps.Builder	resultPath(String resultPath)	Sets the value of TaskStateBaseProps.getResultPath()
EcsRunTaskProps.Builder	resultSelector(Map<String,? extends Object> resultSelector)	Sets the value of TaskStateBaseProps.getResultSelector()
EcsRunTaskProps.Builder	revisionNumber(Number revisionNumber)	Sets the value of EcsRunTaskProps.getRevisionNumber()
EcsRunTaskProps.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups)	Sets the value of EcsRunTaskProps.getSecurityGroups()
EcsRunTaskProps.Builder	stateName(String stateName)	Sets the value of StateBaseProps.getStateName()
EcsRunTaskProps.Builder	subnets(SubnetSelection subnets)	Sets the value of EcsRunTaskProps.getSubnets()
EcsRunTaskProps.Builder	taskDefinition(TaskDefinition taskDefinition)	Sets the value of EcsRunTaskProps.getTaskDefinition()
EcsRunTaskProps.Builder	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseOptions.getTaskTimeout()
EcsRunTaskProps.Builder	timeout(Duration timeout)	Deprecated. use `taskTimeout`

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

cluster

@Stability(Stable)
public EcsRunTaskProps.Builder cluster(ICluster cluster)

Sets the value of EcsRunTaskProps.getCluster()

Parameters:

cluster - The ECS cluster to run the task on. This parameter is required.

Returns:

this

launchTarget

@Stability(Stable)
public EcsRunTaskProps.Builder launchTarget(IEcsLaunchTarget launchTarget)

Sets the value of EcsRunTaskProps.getLaunchTarget()

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

taskDefinition

@Stability(Stable)
public EcsRunTaskProps.Builder taskDefinition(TaskDefinition taskDefinition)

Sets the value of EcsRunTaskProps.getTaskDefinition()

Parameters:

taskDefinition - [disable-awslint:ref-via-interface] Task Definition used for running tasks in the service. This parameter is required. Note: this must be TaskDefinition, and not ITaskDefinition, as it requires properties that are not known for imported task definitions If you want to run a RunTask with an imported task definition, consider using CustomState

Returns:

this

assignPublicIp

@Stability(Stable)
public EcsRunTaskProps.Builder assignPublicIp(Boolean assignPublicIp)

Sets the value of EcsRunTaskProps.getAssignPublicIp()

Parameters:

assignPublicIp - Assign public IP addresses to each task.

Returns:

this

containerOverrides

@Stability(Stable)
public EcsRunTaskProps.Builder containerOverrides(List<? extends ContainerOverride> containerOverrides)

Sets the value of EcsRunTaskProps.getContainerOverrides()

Parameters:

containerOverrides - Container setting overrides. Specify the container to use and the overrides to apply.

Returns:

this

cpu

@Stability(Stable)
public EcsRunTaskProps.Builder cpu(String cpu)

Sets the value of EcsRunTaskProps.getCpu()

Parameters:

cpu - Cpu setting override.

Returns:

this

enableExecuteCommand

@Stability(Stable)
public EcsRunTaskProps.Builder enableExecuteCommand(Boolean enableExecuteCommand)

Sets the value of EcsRunTaskProps.getEnableExecuteCommand()

Parameters:

enableExecuteCommand - Whether ECS Exec should be enabled.

Returns:

this

memoryMiB

@Stability(Stable)
public EcsRunTaskProps.Builder memoryMiB(String memoryMiB)

Sets the value of EcsRunTaskProps.getMemoryMiB()

Parameters:

memoryMiB - Memory setting override.

Returns:

this

propagatedTagSource

@Stability(Stable)
public EcsRunTaskProps.Builder propagatedTagSource(PropagatedTagSource propagatedTagSource)

Sets the value of EcsRunTaskProps.getPropagatedTagSource()

Parameters:

propagatedTagSource - Specifies whether to propagate the tags from the task definition to the task. An error will be received if you specify the SERVICE option when running a task.

Returns:

this

revisionNumber

@Stability(Stable)
public EcsRunTaskProps.Builder revisionNumber(Number revisionNumber)

Sets the value of EcsRunTaskProps.getRevisionNumber()

Parameters:

revisionNumber - The revision number of ECS task definition family.

Returns:

this

securityGroups

@Stability(Stable)
public EcsRunTaskProps.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)

Sets the value of EcsRunTaskProps.getSecurityGroups()

Parameters:

securityGroups - Existing security groups to use for the tasks.

Returns:

this

subnets

@Stability(Stable)
public EcsRunTaskProps.Builder subnets(SubnetSelection subnets)

Sets the value of EcsRunTaskProps.getSubnets()

Parameters:

subnets - Subnets to place the task's ENIs.

Returns:

this

resultPath

@Stability(Stable)
public EcsRunTaskProps.Builder resultPath(String resultPath)

Sets the value of TaskStateBaseProps.getResultPath()

Parameters:

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.

Returns:

this

resultSelector

@Stability(Stable)
public EcsRunTaskProps.Builder resultSelector(Map<String,? extends Object> resultSelector)

Sets the value of TaskStateBaseProps.getResultSelector()

Parameters:

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.

Returns:

this

comment

@Stability(Stable)
public EcsRunTaskProps.Builder comment(String comment)

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

@Stability(Stable)
public EcsRunTaskProps.Builder queryLanguage(QueryLanguage queryLanguage)

Sets the value of StateBaseProps.getQueryLanguage()

Parameters:

queryLanguage - The name of the query language used by the state. If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

Returns:

this

stateName

@Stability(Stable)
public EcsRunTaskProps.Builder stateName(String stateName)

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

@Stability(Stable)
public EcsRunTaskProps.Builder credentials(Credentials credentials)

Sets the value of TaskStateBaseOptions.getCredentials()

Parameters:

credentials - Credentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations.

Returns:

this

heartbeat

@Stability(Deprecated)
@Deprecated
public EcsRunTaskProps.Builder heartbeat(Duration heartbeat)

Deprecated.

use `heartbeatTimeout`

Sets the value of TaskStateBaseOptions.getHeartbeat()

Parameters:

heartbeat - Timeout for the heartbeat.

Returns:

this

heartbeatTimeout

@Stability(Stable)
public EcsRunTaskProps.Builder heartbeatTimeout(Timeout heartbeatTimeout)

Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()

Parameters:

heartbeatTimeout - Timeout for the heartbeat. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

integrationPattern

@Stability(Stable)
public EcsRunTaskProps.Builder integrationPattern(IntegrationPattern integrationPattern)

Sets the value of TaskStateBaseOptions.getIntegrationPattern()

Parameters:

integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

Returns:

this

taskTimeout

@Stability(Stable)
public EcsRunTaskProps.Builder taskTimeout(Timeout taskTimeout)

Sets the value of TaskStateBaseOptions.getTaskTimeout()

Parameters:

taskTimeout - Timeout for the task. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

timeout

@Stability(Deprecated)
@Deprecated
public EcsRunTaskProps.Builder timeout(Duration timeout)

Deprecated.

use `taskTimeout`

Sets the value of TaskStateBaseOptions.getTimeout()

Parameters:

timeout - Timeout for the task.

Returns:

this

assign

@Stability(Stable)
public EcsRunTaskProps.Builder assign(Map<String,? extends Object> assign)

Sets the value of AssignableStateOptions.getAssign()

Parameters:

assign - Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps.

Returns:

this

inputPath

@Stability(Stable)
public EcsRunTaskProps.Builder inputPath(String inputPath)

Sets the value of JsonPathCommonOptions.getInputPath()

Parameters:

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 {}.

Returns:

this

outputPath

@Stability(Stable)
public EcsRunTaskProps.Builder outputPath(String outputPath)

Sets the value of JsonPathCommonOptions.getOutputPath()

Parameters:

outputPath - JSONPath expression to select part of the state to be the output to this state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Returns:

this

outputs

@Stability(Stable)
public EcsRunTaskProps.Builder outputs(Object outputs)

Sets the value of JsonataCommonOptions.getOutputs()

Parameters:

outputs - Used to specify and transform output from the state. When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

Returns:

this

build

@Stability(Stable)
public EcsRunTaskProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of EcsRunTaskProps

Throws:

NullPointerException - if any required attribute was not provided