SnsPublish.Builder (AWS CDK 1.202.0 API)

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

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

Enclosing class:: SnsPublish

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

A fluent builder for SnsPublish.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SnsPublish`	`build()`
`SnsPublish.Builder`	`comment(String comment)` An optional description for this state.
`static SnsPublish.Builder`	`create(software.constructs.Construct scope, String id)`
`SnsPublish.Builder`	`heartbeat(Duration heartbeat)` Timeout for the heartbeat.
`SnsPublish.Builder`	`inputPath(String inputPath)` JSONPath expression to select part of the state to be the input to this state.
`SnsPublish.Builder`	`integrationPattern(IntegrationPattern integrationPattern)` AWS Step Functions integrates with services directly in the Amazon States Language.
`SnsPublish.Builder`	`message(TaskInput message)` The message you want to send.
`SnsPublish.Builder`	`messageAttributes(Map<String,? extends MessageAttribute> messageAttributes)` Add message attributes when publishing.
`SnsPublish.Builder`	`messagePerSubscriptionType(Boolean messagePerSubscriptionType)` Send different messages for each transport protocol.
`SnsPublish.Builder`	`outputPath(String outputPath)` JSONPath expression to select select a portion of the state output to pass to the next state.
`SnsPublish.Builder`	`resultPath(String resultPath)` JSONPath expression to indicate where to inject the state's output.
`SnsPublish.Builder`	`resultSelector(Map<String,? extends Object> resultSelector)` The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
`SnsPublish.Builder`	`subject(String subject)` Used as the "Subject" line when the message is delivered to email endpoints.
`SnsPublish.Builder`	`timeout(Duration timeout)` Timeout for the state machine.
`SnsPublish.Builder`	`topic(ITopic topic)` The SNS topic that the task will publish to.

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

- Method Detail
  - create
```
@Stability(value=Stable)
public static SnsPublish.Builder create(software.constructs.Construct scope,
                                                                 String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of SnsPublish.Builder.
  - comment
```
@Stability(value=Stable)
public SnsPublish.Builder comment(String comment)
```
    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=Stable)
public SnsPublish.Builder heartbeat(Duration heartbeat)
```
    Timeout for the heartbeat.
    Default: - None
    
    Parameters:
    
    heartbeat - Timeout for the heartbeat. This parameter is required.
    
    Returns:
    
    this
  - inputPath
```
@Stability(value=Stable)
public SnsPublish.Builder inputPath(String 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 {}.
    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=Stable)
public SnsPublish.Builder integrationPattern(IntegrationPattern integrationPattern)
```
    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` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.
    
    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=Stable)
public SnsPublish.Builder outputPath(String 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 {}.
    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=Stable)
public SnsPublish.Builder resultPath(String 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.
    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=Stable)
public SnsPublish.Builder resultSelector(Map<String,? extends Object> 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.
    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=Stable)
public SnsPublish.Builder timeout(Duration timeout)
```
    Timeout for the state machine.
    Default: - None
    
    Parameters:
    
    timeout - Timeout for the state machine. This parameter is required.
    
    Returns:
    
    this
  - message
```
@Stability(value=Stable)
public SnsPublish.Builder message(TaskInput message)
```
    The message you want to send.
    With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size. For SMS, each message can contain up to 140 characters.
    
    Parameters:
    
    message - The message you want to send. This parameter is required.
    
    Returns:
    
    this
  - topic
```
@Stability(value=Stable)
public SnsPublish.Builder topic(ITopic topic)
```
    The SNS topic that the task will publish to.
    
    Parameters:
    
    topic - The SNS topic that the task will publish to. This parameter is required.
    
    Returns:
    
    this
  - messageAttributes
```
@Stability(value=Stable)
public SnsPublish.Builder messageAttributes(Map<String,? extends MessageAttribute> messageAttributes)
```
    Add message attributes when publishing.
    These attributes carry additional metadata about the message and may be used for subscription filters.
    Default: {}
    
    Parameters:
    
    messageAttributes - Add message attributes when publishing. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/sns/latest/dg/sns-message-attributes.html
  - messagePerSubscriptionType
```
@Stability(value=Stable)
public SnsPublish.Builder messagePerSubscriptionType(Boolean messagePerSubscriptionType)
```
    Send different messages for each transport protocol.
    For example, you might want to send a shorter message to SMS subscribers and a more verbose message to email and SQS subscribers.
    Your message must be a JSON object with a top-level JSON key of "default" with a value that is a string You can define other top-level keys that define the message you want to send to a specific transport protocol (i.e. "sqs", "email", "http", etc)
    Default: false
    
    Parameters:
    
    messagePerSubscriptionType - Send different messages for each transport protocol. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/sns/latest/api/API_Publish.html#API_Publish_RequestParameters
  - subject
```
@Stability(value=Stable)
public SnsPublish.Builder subject(String subject)
```
    Used as the "Subject" line when the message is delivered to email endpoints.
    This field will also be included, if present, in the standard JSON messages delivered to other endpoints.
    Default: - No subject
    
    Parameters:
    
    subject - Used as the "Subject" line when the message is delivered to email endpoints. This parameter is required.
    
    Returns:
    
    this
  - build
```
@Stability(value=Stable)
public SnsPublish build()
```
    Specified by:
    
    build in interface software.amazon.jsii.Builder<SnsPublish>

Class SnsPublish.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

comment

heartbeat

inputPath

integrationPattern

outputPath

resultPath

resultSelector

timeout

message

topic

messageAttributes

messagePerSubscriptionType

subject

build