SqsSendMessage.Builder (software.amazon.awscdk:aws-cdk-lib 2.0.0-rc.10 API)

java.lang.Object
- software.amazon.awscdk.services.stepfunctions.tasks.SqsSendMessage.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<SqsSendMessage>

Enclosing class:: SqsSendMessage

@Stability(value=Experimental)
public static final class SqsSendMessage.Builder
extends Object
implements software.amazon.jsii.Builder<SqsSendMessage>

(experimental) A fluent builder for SqsSendMessage.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SqsSendMessage`	`build()`
`SqsSendMessage.Builder`	`comment(String comment)` (experimental) An optional description for this state.
`static SqsSendMessage.Builder`	`create(software.constructs.Construct scope, String id)`
`SqsSendMessage.Builder`	`delay(Duration delay)` (experimental) The length of time, for which to delay a message.
`SqsSendMessage.Builder`	`heartbeat(Duration heartbeat)` (experimental) Timeout for the heartbeat.
`SqsSendMessage.Builder`	`inputPath(String inputPath)` (experimental) JSONPath expression to select part of the state to be the input to this state.
`SqsSendMessage.Builder`	`integrationPattern(IntegrationPattern integrationPattern)` (experimental) AWS Step Functions integrates with services directly in the Amazon States Language.
`SqsSendMessage.Builder`	`messageBody(TaskInput messageBody)` (experimental) The text message to send to the queue.
`SqsSendMessage.Builder`	`messageDeduplicationId(String messageDeduplicationId)` (experimental) The token used for deduplication of sent messages.
`SqsSendMessage.Builder`	`messageGroupId(String messageGroupId)` (experimental) The tag that specifies that a message belongs to a specific message group.
`SqsSendMessage.Builder`	`outputPath(String outputPath)` (experimental) JSONPath expression to select select a portion of the state output to pass to the next state.
`SqsSendMessage.Builder`	`queue(IQueue queue)` (experimental) The SQS queue that messages will be sent to.
`SqsSendMessage.Builder`	`resultPath(String resultPath)` (experimental) JSONPath expression to indicate where to inject the state's output.
`SqsSendMessage.Builder`	`resultSelector(Map<String,? extends Object> resultSelector)` (experimental) The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
`SqsSendMessage.Builder`	`timeout(Duration timeout)` (experimental) Timeout for the state machine.

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 SqsSendMessage.Builder create(software.constructs.Construct scope,
                                                                           String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of SqsSendMessage.Builder.
  - comment
```
@Stability(value=Experimental)
public SqsSendMessage.Builder comment(String comment)
```
    (experimental) An optional description for this state.
    Default: - No comment
    
    Parameters:
    
    comment - An optional description for this state. This parameter is required.
    
    Returns:
    
    this
  - heartbeat
```
@Stability(value=Experimental)
public SqsSendMessage.Builder heartbeat(Duration heartbeat)
```
    (experimental) Timeout for the heartbeat.
    Default: - None
    
    Parameters:
    
    heartbeat - Timeout for the heartbeat. This parameter is required.
    
    Returns:
    
    this
  - inputPath
```
@Stability(value=Experimental)
public SqsSendMessage.Builder inputPath(String inputPath)
```
    (experimental) 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 {}.
    Default: - The entire task input (JSON path '$')
    
    Parameters:
    
    inputPath - JSONPath expression to select part of the state to be the input to this state. This parameter is required.
    
    Returns:
    
    this
  - integrationPattern
```
@Stability(value=Experimental)
public SqsSendMessage.Builder integrationPattern(IntegrationPattern integrationPattern)
```
    (experimental) AWS Step Functions integrates with services directly in the Amazon States Language.
    You can control these AWS services using service integration patterns
    Default: IntegrationPattern.REQUEST_RESPONSE
    
    Parameters:
    
    integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
  - outputPath
```
@Stability(value=Experimental)
public SqsSendMessage.Builder outputPath(String outputPath)
```
    (experimental) JSONPath expression to select select a portion of the state output to pass to the next state.
    May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
    Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')
    
    Parameters:
    
    outputPath - JSONPath expression to select select a portion of the state output to pass to the next state. This parameter is required.
    
    Returns:
    
    this
  - resultPath
```
@Stability(value=Experimental)
public SqsSendMessage.Builder resultPath(String resultPath)
```
    (experimental) 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.
    Default: - Replaces the entire input with the result (JSON path '$')
    
    Parameters:
    
    resultPath - JSONPath expression to indicate where to inject the state's output. This parameter is required.
    
    Returns:
    
    this
  - resultSelector
```
@Stability(value=Experimental)
public SqsSendMessage.Builder resultSelector(Map<String,? extends Object> resultSelector)
```
    (experimental) 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.
    Default: - None
    
    Parameters:
    
    resultSelector - The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector
  - timeout
```
@Stability(value=Experimental)
public SqsSendMessage.Builder timeout(Duration timeout)
```
    (experimental) Timeout for the state machine.
    Default: - None
    
    Parameters:
    
    timeout - Timeout for the state machine. This parameter is required.
    
    Returns:
    
    this
  - messageBody
```
@Stability(value=Experimental)
public SqsSendMessage.Builder messageBody(TaskInput messageBody)
```
    (experimental) The text message to send to the queue.
    
    Parameters:
    
    messageBody - The text message to send to the queue. This parameter is required.
    
    Returns:
    
    this
  - queue
```
@Stability(value=Experimental)
public SqsSendMessage.Builder queue(IQueue queue)
```
    (experimental) The SQS queue that messages will be sent to.
    
    Parameters:
    
    queue - The SQS queue that messages will be sent to. This parameter is required.
    
    Returns:
    
    this
  - delay
```
@Stability(value=Experimental)
public SqsSendMessage.Builder delay(Duration delay)
```
    (experimental) 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.
    Default: - delay set on the queue. If a delay is not set on the queue, messages are sent immediately (0 seconds).
    
    Parameters:
    
    delay - The length of time, for which to delay a message. This parameter is required.
    
    Returns:
    
    this
  - messageDeduplicationId
```
@Stability(value=Experimental)
public SqsSendMessage.Builder messageDeduplicationId(String messageDeduplicationId)
```
    (experimental) 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.
    Default: - None
    
    Parameters:
    
    messageDeduplicationId - The token used for deduplication of sent messages. This parameter is required.
    
    Returns:
    
    this
  - messageGroupId
```
@Stability(value=Experimental)
public SqsSendMessage.Builder messageGroupId(String messageGroupId)
```
    (experimental) 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.
    Default: - None
    
    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 SqsSendMessage build()
```
    Specified by:
    
    build in interface software.amazon.jsii.Builder<SqsSendMessage>

Class SqsSendMessage.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

comment

heartbeat

inputPath

integrationPattern

outputPath

resultPath

resultSelector

timeout

messageBody

queue

delay

messageDeduplicationId

messageGroupId

build