public static final class SnsPublishProps.Builder
extends java.lang.Object
SnsPublishProps
Constructor and Description |
---|
Builder() |
public SnsPublishProps.Builder message(TaskInput message)
SnsPublishProps.getMessage()
message
- The message you want to send. This parameter is required.
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.this
public SnsPublishProps.Builder topic(ITopic topic)
SnsPublishProps.getTopic()
topic
- The SNS topic that the task will publish to. This parameter is required.this
public SnsPublishProps.Builder messageAttributes(java.util.Map<java.lang.String,? extends MessageAttribute> messageAttributes)
SnsPublishProps.getMessageAttributes()
messageAttributes
- Add message attributes when publishing.
These attributes carry additional metadata about the message and may be used
for subscription filters.this
public SnsPublishProps.Builder messagePerSubscriptionType(java.lang.Boolean messagePerSubscriptionType)
SnsPublishProps.getMessagePerSubscriptionType()
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)
this
public SnsPublishProps.Builder subject(java.lang.String subject)
SnsPublishProps.getSubject()
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.this
public SnsPublishProps.Builder comment(java.lang.String comment)
TaskStateBaseProps.getComment()
comment
- An optional description for this state.this
public SnsPublishProps.Builder heartbeat(Duration heartbeat)
TaskStateBaseProps.getHeartbeat()
heartbeat
- Timeout for the heartbeat.this
public SnsPublishProps.Builder inputPath(java.lang.String inputPath)
TaskStateBaseProps.getInputPath()
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 {}.this
public SnsPublishProps.Builder integrationPattern(IntegrationPattern integrationPattern)
TaskStateBaseProps.getIntegrationPattern()
integrationPattern
- AWS Step Functions integrates with services directly in the Amazon States Language.
You can control these AWS services using service integration patternsthis
public SnsPublishProps.Builder outputPath(java.lang.String outputPath)
TaskStateBaseProps.getOutputPath()
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 {}.this
public SnsPublishProps.Builder resultPath(java.lang.String resultPath)
TaskStateBaseProps.getResultPath()
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.this
public SnsPublishProps.Builder resultSelector(java.util.Map<java.lang.String,? extends java.lang.Object> resultSelector)
TaskStateBaseProps.getResultSelector()
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.this
public SnsPublishProps.Builder timeout(Duration timeout)
TaskStateBaseProps.getTimeout()
timeout
- Timeout for the state machine.this
public SnsPublishProps build()
SnsPublishProps
java.lang.NullPointerException
- if any required attribute was not provided