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

Class EcsRunTaskJsonPathProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<EcsRunTaskJsonPathProps>

Enclosing interface:

EcsRunTaskJsonPathProps

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

A builder for EcsRunTaskJsonPathProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Sets the value of EcsRunTaskJsonPathProps.getCluster()

Parameters:

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

Returns:

this

launchTarget

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

Sets the value of EcsRunTaskJsonPathProps.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 EcsRunTaskJsonPathProps.Builder taskDefinition(TaskDefinition taskDefinition)

Sets the value of EcsRunTaskJsonPathProps.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 EcsRunTaskJsonPathProps.Builder assignPublicIp(Boolean assignPublicIp)

Sets the value of EcsRunTaskJsonPathProps.getAssignPublicIp()

Parameters:

assignPublicIp - Assign public IP addresses to each task.

Returns:

this

containerOverrides

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

Sets the value of EcsRunTaskJsonPathProps.getContainerOverrides()

Parameters:

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

Returns:

this

cpu

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

Sets the value of EcsRunTaskJsonPathProps.getCpu()

Parameters:

cpu - Cpu setting override.

Returns:

this

enableExecuteCommand

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

Sets the value of EcsRunTaskJsonPathProps.getEnableExecuteCommand()

Parameters:

enableExecuteCommand - Whether ECS Exec should be enabled.

Returns:

this

memoryMiB

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

Sets the value of EcsRunTaskJsonPathProps.getMemoryMiB()

Parameters:

memoryMiB - Memory setting override.

Returns:

this

propagatedTagSource

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

Sets the value of EcsRunTaskJsonPathProps.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 EcsRunTaskJsonPathProps.Builder revisionNumber(Number revisionNumber)

Sets the value of EcsRunTaskJsonPathProps.getRevisionNumber()

Parameters:

revisionNumber - The revision number of ECS task definition family.

Returns:

this

securityGroups

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

Sets the value of EcsRunTaskJsonPathProps.getSecurityGroups()

Parameters:

securityGroups - Existing security groups to use for the tasks.

Returns:

this

subnets

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

Sets the value of EcsRunTaskJsonPathProps.getSubnets()

Parameters:

subnets - Subnets to place the task's ENIs.

Returns:

this

resultPath

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

Sets the value of TaskStateJsonPathBaseProps.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 EcsRunTaskJsonPathProps.Builder resultSelector(Map<String,? extends Object> resultSelector)

Sets the value of TaskStateJsonPathBaseProps.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 EcsRunTaskJsonPathProps.Builder comment(String comment)

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

@Stability(Stable)
public EcsRunTaskJsonPathProps.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 EcsRunTaskJsonPathProps.Builder stateName(String stateName)

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

@Stability(Stable)
public EcsRunTaskJsonPathProps.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 EcsRunTaskJsonPathProps.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 EcsRunTaskJsonPathProps.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 EcsRunTaskJsonPathProps.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 EcsRunTaskJsonPathProps.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 EcsRunTaskJsonPathProps.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 EcsRunTaskJsonPathProps.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 EcsRunTaskJsonPathProps.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 EcsRunTaskJsonPathProps.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

build

@Stability(Stable)
public EcsRunTaskJsonPathProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of EcsRunTaskJsonPathProps

Throws:

NullPointerException - if any required attribute was not provided