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

Class SqsSendMessageProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<SqsSendMessageProps>

Enclosing interface:

SqsSendMessageProps

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

A builder for SqsSendMessageProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SqsSendMessageProps.Builder	assign(Map<String,? extends Object> assign)	Sets the value of AssignableStateOptions.getAssign()
SqsSendMessageProps	build()	Builds the configured instance.
SqsSendMessageProps.Builder	comment(String comment)	Sets the value of StateBaseProps.getComment()
SqsSendMessageProps.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseOptions.getCredentials()
SqsSendMessageProps.Builder	delay(Duration delay)	Sets the value of SqsSendMessageProps.getDelay()
SqsSendMessageProps.Builder	heartbeat(Duration heartbeat)	Deprecated. use `heartbeatTimeout`
SqsSendMessageProps.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()
SqsSendMessageProps.Builder	inputPath(String inputPath)	Sets the value of JsonPathCommonOptions.getInputPath()
SqsSendMessageProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseOptions.getIntegrationPattern()
SqsSendMessageProps.Builder	messageBody(TaskInput messageBody)	Sets the value of SqsSendMessageProps.getMessageBody()
SqsSendMessageProps.Builder	messageDeduplicationId(String messageDeduplicationId)	Sets the value of SqsSendMessageProps.getMessageDeduplicationId()
SqsSendMessageProps.Builder	messageGroupId(String messageGroupId)	Sets the value of SqsSendMessageProps.getMessageGroupId()
SqsSendMessageProps.Builder	outputPath(String outputPath)	Sets the value of JsonPathCommonOptions.getOutputPath()
SqsSendMessageProps.Builder	outputs(Object outputs)	Sets the value of JsonataCommonOptions.getOutputs()
SqsSendMessageProps.Builder	queryLanguage(QueryLanguage queryLanguage)	Sets the value of StateBaseProps.getQueryLanguage()
SqsSendMessageProps.Builder	queue(IQueue queue)	Sets the value of SqsSendMessageProps.getQueue()
SqsSendMessageProps.Builder	resultPath(String resultPath)	Sets the value of TaskStateBaseProps.getResultPath()
SqsSendMessageProps.Builder	resultSelector(Map<String,? extends Object> resultSelector)	Sets the value of TaskStateBaseProps.getResultSelector()
SqsSendMessageProps.Builder	stateName(String stateName)	Sets the value of StateBaseProps.getStateName()
SqsSendMessageProps.Builder	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseOptions.getTaskTimeout()
SqsSendMessageProps.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

messageBody

@Stability(Stable)
public SqsSendMessageProps.Builder messageBody(TaskInput messageBody)

Sets the value of SqsSendMessageProps.getMessageBody()

Parameters:

messageBody - The text message to send to the queue. This parameter is required.

Returns:

this

queue

@Stability(Stable)
public SqsSendMessageProps.Builder queue(IQueue queue)

Sets the value of SqsSendMessageProps.getQueue()

Parameters:

queue - The SQS queue that messages will be sent to. This parameter is required.

Returns:

this

delay

@Stability(Stable)
public SqsSendMessageProps.Builder delay(Duration delay)

Sets the value of SqsSendMessageProps.getDelay()

Parameters:

delay - The length of time, for which to delay a message. Messages that you send to the queue remain invisible to consumers for the duration of the delay period. The maximum allowed delay is 15 minutes.

Returns:

this

messageDeduplicationId

@Stability(Stable)
public SqsSendMessageProps.Builder messageDeduplicationId(String messageDeduplicationId)

Sets the value of SqsSendMessageProps.getMessageDeduplicationId()

Parameters:

messageDeduplicationId - The token used for deduplication of sent messages. Any messages sent with the same deduplication ID are accepted successfully, but aren't delivered during the 5-minute deduplication interval.

Returns:

this

messageGroupId

@Stability(Stable)
public SqsSendMessageProps.Builder messageGroupId(String messageGroupId)

Sets the value of SqsSendMessageProps.getMessageGroupId()

Parameters:

messageGroupId - The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner. Messages in different message groups might be processed out of order.

Returns:

this

resultPath

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

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

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

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SqsSendMessageProps

Throws:

NullPointerException - if any required attribute was not provided