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

Class EcsRunTaskJsonataProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<EcsRunTaskJsonataProps>

Enclosing interface:

EcsRunTaskJsonataProps

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

A builder for EcsRunTaskJsonataProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Sets the value of EcsRunTaskJsonataProps.getCluster()

Parameters:

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

Returns:

this

launchTarget

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

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

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

Sets the value of EcsRunTaskJsonataProps.getAssignPublicIp()

Parameters:

assignPublicIp - Assign public IP addresses to each task.

Returns:

this

containerOverrides

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

Sets the value of EcsRunTaskJsonataProps.getContainerOverrides()

Parameters:

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

Returns:

this

cpu

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

Sets the value of EcsRunTaskJsonataProps.getCpu()

Parameters:

cpu - Cpu setting override.

Returns:

this

enableExecuteCommand

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

Sets the value of EcsRunTaskJsonataProps.getEnableExecuteCommand()

Parameters:

enableExecuteCommand - Whether ECS Exec should be enabled.

Returns:

this

memoryMiB

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

Sets the value of EcsRunTaskJsonataProps.getMemoryMiB()

Parameters:

memoryMiB - Memory setting override.

Returns:

this

propagatedTagSource

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

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

Sets the value of EcsRunTaskJsonataProps.getRevisionNumber()

Parameters:

revisionNumber - The revision number of ECS task definition family.

Returns:

this

securityGroups

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

Sets the value of EcsRunTaskJsonataProps.getSecurityGroups()

Parameters:

securityGroups - Existing security groups to use for the tasks.

Returns:

this

subnets

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

Sets the value of EcsRunTaskJsonataProps.getSubnets()

Parameters:

subnets - Subnets to place the task's ENIs.

Returns:

this

comment

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

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

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

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

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

outputs

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of EcsRunTaskJsonataProps

Throws:

NullPointerException - if any required attribute was not provided