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

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

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

Enclosing interface:: SqsSendMessageProps

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

A builder for SqsSendMessageProps

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SqsSendMessageProps`	`build()` Builds the configured instance.
`SqsSendMessageProps.Builder`	`comment(String comment)` Sets the value of `TaskStateBaseProps.getComment()`
`SqsSendMessageProps.Builder`	`delay(Duration delay)` Sets the value of `SqsSendMessageProps.getDelay()`
`SqsSendMessageProps.Builder`	`heartbeat(Duration heartbeat)` Sets the value of `TaskStateBaseProps.getHeartbeat()`
`SqsSendMessageProps.Builder`	`inputPath(String inputPath)` Sets the value of `TaskStateBaseProps.getInputPath()`
`SqsSendMessageProps.Builder`	`integrationPattern(IntegrationPattern integrationPattern)` Sets the value of `TaskStateBaseProps.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 `TaskStateBaseProps.getOutputPath()`
`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`	`timeout(Duration timeout)` Sets the value of `TaskStateBaseProps.getTimeout()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - messageBody
```
@Stability(value=Experimental)
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(value=Experimental)
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(value=Experimental)
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(value=Experimental)
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(value=Experimental)
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
  - comment
```
@Stability(value=Experimental)
public SqsSendMessageProps.Builder comment(String comment)
```
    Sets the value of TaskStateBaseProps.getComment()
    
    Parameters:
    
    comment - An optional description for this state.
    
    Returns:
    
    this
  - heartbeat
```
@Stability(value=Experimental)
public SqsSendMessageProps.Builder heartbeat(Duration heartbeat)
```
    Sets the value of TaskStateBaseProps.getHeartbeat()
    
    Parameters:
    
    heartbeat - Timeout for the heartbeat.
    
    Returns:
    
    this
  - inputPath
```
@Stability(value=Experimental)
public SqsSendMessageProps.Builder inputPath(String inputPath)
```
    Sets the value of TaskStateBaseProps.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
  - integrationPattern
```
@Stability(value=Experimental)
public SqsSendMessageProps.Builder integrationPattern(IntegrationPattern integrationPattern)
```
    Sets the value of TaskStateBaseProps.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
    
    Returns:
    
    this
  - outputPath
```
@Stability(value=Experimental)
public SqsSendMessageProps.Builder outputPath(String outputPath)
```
    Sets the value of TaskStateBaseProps.getOutputPath()
    
    Parameters:
    
    outputPath - 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 {}.
    
    Returns:
    
    this
  - resultPath
```
@Stability(value=Experimental)
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(value=Experimental)
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
  - timeout
```
@Stability(value=Experimental)
public SqsSendMessageProps.Builder timeout(Duration timeout)
```
    Sets the value of TaskStateBaseProps.getTimeout()
    
    Parameters:
    
    timeout - Timeout for the state machine.
    
    Returns:
    
    this
  - build
```
@Stability(value=Experimental)
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

Class SqsSendMessageProps.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

messageBody

queue

delay

messageDeduplicationId

messageGroupId

comment

heartbeat

inputPath

integrationPattern

outputPath

resultPath

resultSelector

timeout

build