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

Class StepFunctionsInvokeActivityProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<StepFunctionsInvokeActivityProps>

Enclosing interface:

StepFunctionsInvokeActivityProps

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

A builder for StepFunctionsInvokeActivityProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StepFunctionsInvokeActivityProps.Builder	activity(IActivity activity)	Sets the value of StepFunctionsInvokeActivityProps.getActivity()
StepFunctionsInvokeActivityProps.Builder	arguments(Object arguments)	Sets the value of JsonataStateOptions.getArguments()
StepFunctionsInvokeActivityProps.Builder	assign(Map<String,? extends Object> assign)	Sets the value of AssignableStateOptions.getAssign()
StepFunctionsInvokeActivityProps	build()	Builds the configured instance.
StepFunctionsInvokeActivityProps.Builder	comment(String comment)	Sets the value of StateBaseProps.getComment()
StepFunctionsInvokeActivityProps.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseOptions.getCredentials()
StepFunctionsInvokeActivityProps.Builder	heartbeat(Duration heartbeat)	Deprecated. use `heartbeatTimeout`
StepFunctionsInvokeActivityProps.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()
StepFunctionsInvokeActivityProps.Builder	inputPath(String inputPath)	Sets the value of JsonPathCommonOptions.getInputPath()
StepFunctionsInvokeActivityProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseOptions.getIntegrationPattern()
StepFunctionsInvokeActivityProps.Builder	outputPath(String outputPath)	Sets the value of JsonPathCommonOptions.getOutputPath()
StepFunctionsInvokeActivityProps.Builder	outputs(Object outputs)	Sets the value of StepFunctionsInvokeActivityProps.getOutputs()
StepFunctionsInvokeActivityProps.Builder	parameters(Map<String,? extends Object> parameters)	Sets the value of StepFunctionsInvokeActivityProps.getParameters()
StepFunctionsInvokeActivityProps.Builder	queryLanguage(QueryLanguage queryLanguage)	Sets the value of StateBaseProps.getQueryLanguage()
StepFunctionsInvokeActivityProps.Builder	resultPath(String resultPath)	Sets the value of TaskStateBaseProps.getResultPath()
StepFunctionsInvokeActivityProps.Builder	resultSelector(Map<String,? extends Object> resultSelector)	Sets the value of TaskStateBaseProps.getResultSelector()
StepFunctionsInvokeActivityProps.Builder	stateName(String stateName)	Sets the value of StateBaseProps.getStateName()
StepFunctionsInvokeActivityProps.Builder	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseOptions.getTaskTimeout()
StepFunctionsInvokeActivityProps.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

activity

@Stability(Stable)
public StepFunctionsInvokeActivityProps.Builder activity(IActivity activity)

Sets the value of StepFunctionsInvokeActivityProps.getActivity()

Parameters:

activity - Step Functions Activity to invoke. This parameter is required.

Returns:

this

parameters

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

Sets the value of StepFunctionsInvokeActivityProps.getParameters()

Parameters:

parameters - Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.

Returns:

this

resultPath

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

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

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

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

@Stability(Stable)
public StepFunctionsInvokeActivityProps.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 StepFunctionsInvokeActivityProps.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 StepFunctionsInvokeActivityProps.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 StepFunctionsInvokeActivityProps.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 StepFunctionsInvokeActivityProps.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 StepFunctionsInvokeActivityProps.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 StepFunctionsInvokeActivityProps.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 StepFunctionsInvokeActivityProps.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 StepFunctionsInvokeActivityProps.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 StepFunctionsInvokeActivityProps.Builder outputs(Object outputs)

Sets the value of StepFunctionsInvokeActivityProps.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

arguments

@Stability(Stable)
public StepFunctionsInvokeActivityProps.Builder arguments(Object arguments)

Sets the value of JsonataStateOptions.getArguments()

Parameters:

arguments - Parameters pass a collection of key-value pairs, either static values or JSONata expressions that select from the input.

Returns:

this

build

@Stability(Stable)
public StepFunctionsInvokeActivityProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of StepFunctionsInvokeActivityProps

Throws:

NullPointerException - if any required attribute was not provided