software.amazon.awscdk.services.stepfunctions.tasks

Class SendToQueue.Builder

java.lang.Object

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

Enclosing class:

SendToQueue

@Stability(value=Experimental)
public static final class SendToQueue.Builder
extends Object

A fluent builder for SendToQueue.

Method Summary

Modifier and Type	Method and Description
SendToQueue	build()
static SendToQueue.Builder	create(IQueue queue) EXPERIMENTAL
SendToQueue.Builder	delay(Duration delay) The length of time, in seconds, for which to delay a specific message.
SendToQueue.Builder	integrationPattern(ServiceIntegrationPattern integrationPattern) The service integration pattern indicates different ways to call SendMessage to SQS.
SendToQueue.Builder	messageBody(TaskInput messageBody) The text message to send to the queue.
SendToQueue.Builder	messageDeduplicationId(String messageDeduplicationId) The token used for deduplication of sent messages.
SendToQueue.Builder	messageGroupId(String messageGroupId) The tag that specifies that a message belongs to a specific message group.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static SendToQueue.Builder create(IQueue queue)

EXPERIMENTAL

Parameters:

queue - This parameter is required.

Returns:

a new instance of SendToQueue.Builder.

messageBody

@Stability(value=Experimental)
public SendToQueue.Builder messageBody(TaskInput messageBody)

The text message to send to the queue.

EXPERIMENTAL

Parameters:

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

Returns:

this

delay

@Stability(value=Experimental)
public SendToQueue.Builder delay(Duration delay)

The length of time, in seconds, for which to delay a specific message.

Valid values are 0-900 seconds.

Default: Default value of the queue is used

EXPERIMENTAL

Parameters:

delay - The length of time, in seconds, for which to delay a specific message. This parameter is required.

Returns:

this

integrationPattern

@Stability(value=Experimental)
public SendToQueue.Builder integrationPattern(ServiceIntegrationPattern integrationPattern)

The service integration pattern indicates different ways to call SendMessage to SQS.

The valid value is either FIRE_AND_FORGET or WAIT_FOR_TASK_TOKEN.

Default: FIRE_AND_FORGET

EXPERIMENTAL

Parameters:

integrationPattern - The service integration pattern indicates different ways to call SendMessage to SQS. This parameter is required.

Returns:

this

messageDeduplicationId

@Stability(value=Experimental)
public SendToQueue.Builder messageDeduplicationId(String messageDeduplicationId)

The token used for deduplication of sent messages.

Default: Use content-based deduplication

EXPERIMENTAL

Parameters:

messageDeduplicationId - The token used for deduplication of sent messages. This parameter is required.

Returns:

this

messageGroupId

@Stability(value=Experimental)
public SendToQueue.Builder messageGroupId(String messageGroupId)

The tag that specifies that a message belongs to a specific message group.

Required for FIFO queues. FIFO ordering applies to messages in the same message group.

Default: No group ID

EXPERIMENTAL

Parameters:

messageGroupId - The tag that specifies that a message belongs to a specific message group. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public SendToQueue build()