Package software.amazon.awscdk.services.stepfunctions.tasks

Class SnsPublishJsonPathProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<SnsPublishJsonPathProps>

Enclosing interface:

SnsPublishJsonPathProps

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

A builder for SnsPublishJsonPathProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SnsPublishJsonPathProps.Builder	assign(Map<String,? extends Object> assign)	Sets the value of AssignableStateOptions.getAssign()
SnsPublishJsonPathProps	build()	Builds the configured instance.
SnsPublishJsonPathProps.Builder	comment(String comment)	Sets the value of StateBaseProps.getComment()
SnsPublishJsonPathProps.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseOptions.getCredentials()
SnsPublishJsonPathProps.Builder	heartbeat(Duration heartbeat)	Deprecated. use `heartbeatTimeout`
SnsPublishJsonPathProps.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()
SnsPublishJsonPathProps.Builder	inputPath(String inputPath)	Sets the value of JsonPathCommonOptions.getInputPath()
SnsPublishJsonPathProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseOptions.getIntegrationPattern()
SnsPublishJsonPathProps.Builder	message(TaskInput message)	Sets the value of SnsPublishJsonPathProps.getMessage()
SnsPublishJsonPathProps.Builder	messageAttributes(Map<String,? extends MessageAttribute> messageAttributes)	Sets the value of SnsPublishJsonPathProps.getMessageAttributes()
SnsPublishJsonPathProps.Builder	messageDeduplicationId(String messageDeduplicationId)	Sets the value of SnsPublishJsonPathProps.getMessageDeduplicationId()
SnsPublishJsonPathProps.Builder	messageGroupId(String messageGroupId)	Sets the value of SnsPublishJsonPathProps.getMessageGroupId()
SnsPublishJsonPathProps.Builder	messagePerSubscriptionType(Boolean messagePerSubscriptionType)	Sets the value of SnsPublishJsonPathProps.getMessagePerSubscriptionType()
SnsPublishJsonPathProps.Builder	outputPath(String outputPath)	Sets the value of JsonPathCommonOptions.getOutputPath()
SnsPublishJsonPathProps.Builder	queryLanguage(QueryLanguage queryLanguage)	Sets the value of StateBaseProps.getQueryLanguage()
SnsPublishJsonPathProps.Builder	resultPath(String resultPath)	Sets the value of TaskStateJsonPathBaseProps.getResultPath()
SnsPublishJsonPathProps.Builder	resultSelector(Map<String,? extends Object> resultSelector)	Sets the value of TaskStateJsonPathBaseProps.getResultSelector()
SnsPublishJsonPathProps.Builder	stateName(String stateName)	Sets the value of StateBaseProps.getStateName()
SnsPublishJsonPathProps.Builder	subject(String subject)	Sets the value of SnsPublishJsonPathProps.getSubject()
SnsPublishJsonPathProps.Builder	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseOptions.getTaskTimeout()
SnsPublishJsonPathProps.Builder	timeout(Duration timeout)	Deprecated. use `taskTimeout`
SnsPublishJsonPathProps.Builder	topic(ITopic topic)	Sets the value of SnsPublishJsonPathProps.getTopic()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

message

@Stability(Stable)
public SnsPublishJsonPathProps.Builder message(TaskInput message)

Sets the value of SnsPublishJsonPathProps.getMessage()

Parameters:

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.

Returns:

this

topic

@Stability(Stable)
public SnsPublishJsonPathProps.Builder topic(ITopic topic)

Sets the value of SnsPublishJsonPathProps.getTopic()

Parameters:

topic - The SNS topic that the task will publish to. This parameter is required.

Returns:

this

messageAttributes

@Stability(Stable)
public SnsPublishJsonPathProps.Builder messageAttributes(Map<String,? extends MessageAttribute> messageAttributes)

Sets the value of SnsPublishJsonPathProps.getMessageAttributes()

Parameters:

messageAttributes - Add message attributes when publishing. These attributes carry additional metadata about the message and may be used for subscription filters.

Returns:

this

messageDeduplicationId

@Stability(Stable)
public SnsPublishJsonPathProps.Builder messageDeduplicationId(String messageDeduplicationId)

Sets the value of SnsPublishJsonPathProps.getMessageDeduplicationId()

Parameters:

messageDeduplicationId - This parameter applies only to FIFO topics. Every message must have a unique MessageDeduplicationId, which is a token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any message sent with the same MessageDeduplicationId during the 5-minute deduplication interval is treated as a duplicate.

If the topic has ContentBasedDeduplication set, the system generates a MessageDeduplicationId based on the contents of the message. Your MessageDeduplicationId overrides the generated one.

Returns:

this

messageGroupId

@Stability(Stable)
public SnsPublishJsonPathProps.Builder messageGroupId(String messageGroupId)

Sets the value of SnsPublishJsonPathProps.getMessageGroupId()

Parameters:

messageGroupId - This parameter applies only to FIFO topics. The MessageGroupId is a 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 (however, messages in different message groups might be processed out of order). Every message must include a MessageGroupId.

Returns:

this

messagePerSubscriptionType

@Stability(Stable)
public SnsPublishJsonPathProps.Builder messagePerSubscriptionType(Boolean messagePerSubscriptionType)

Sets the value of SnsPublishJsonPathProps.getMessagePerSubscriptionType()

Parameters:

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)

Returns:

this

subject

@Stability(Stable)
public SnsPublishJsonPathProps.Builder subject(String subject)

Sets the value of SnsPublishJsonPathProps.getSubject()

Parameters:

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.

Returns:

this

resultPath

@Stability(Stable)
public SnsPublishJsonPathProps.Builder resultPath(String resultPath)

Sets the value of TaskStateJsonPathBaseProps.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(Stable)
public SnsPublishJsonPathProps.Builder resultSelector(Map<String,? extends Object> resultSelector)

Sets the value of TaskStateJsonPathBaseProps.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

comment

@Stability(Stable)
public SnsPublishJsonPathProps.Builder comment(String comment)

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

@Stability(Stable)
public SnsPublishJsonPathProps.Builder queryLanguage(QueryLanguage queryLanguage)

Sets the value of StateBaseProps.getQueryLanguage()

Parameters:

queryLanguage - The name of the query language used by the state. If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

Returns:

this

stateName

@Stability(Stable)
public SnsPublishJsonPathProps.Builder stateName(String stateName)

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

@Stability(Stable)
public SnsPublishJsonPathProps.Builder credentials(Credentials credentials)

Sets the value of TaskStateBaseOptions.getCredentials()

Parameters:

credentials - Credentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations.

Returns:

this

heartbeat

@Stability(Deprecated)
@Deprecated
public SnsPublishJsonPathProps.Builder heartbeat(Duration heartbeat)

Deprecated.

use `heartbeatTimeout`

Sets the value of TaskStateBaseOptions.getHeartbeat()

Parameters:

heartbeat - Timeout for the heartbeat.

Returns:

this

heartbeatTimeout

@Stability(Stable)
public SnsPublishJsonPathProps.Builder heartbeatTimeout(Timeout heartbeatTimeout)

Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()

Parameters:

heartbeatTimeout - Timeout for the heartbeat. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

integrationPattern

@Stability(Stable)
public SnsPublishJsonPathProps.Builder integrationPattern(IntegrationPattern integrationPattern)

Sets the value of TaskStateBaseOptions.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.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

Returns:

this

taskTimeout

@Stability(Stable)
public SnsPublishJsonPathProps.Builder taskTimeout(Timeout taskTimeout)

Sets the value of TaskStateBaseOptions.getTaskTimeout()

Parameters:

taskTimeout - Timeout for the task. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

timeout

@Stability(Deprecated)
@Deprecated
public SnsPublishJsonPathProps.Builder timeout(Duration timeout)

Deprecated.

use `taskTimeout`

Sets the value of TaskStateBaseOptions.getTimeout()

Parameters:

timeout - Timeout for the task.

Returns:

this

assign

@Stability(Stable)
public SnsPublishJsonPathProps.Builder assign(Map<String,? extends Object> assign)

Sets the value of AssignableStateOptions.getAssign()

Parameters:

assign - Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps.

Returns:

this

inputPath

@Stability(Stable)
public SnsPublishJsonPathProps.Builder inputPath(String inputPath)

Sets the value of JsonPathCommonOptions.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

outputPath

@Stability(Stable)
public SnsPublishJsonPathProps.Builder outputPath(String outputPath)

Sets the value of JsonPathCommonOptions.getOutputPath()

Parameters:

outputPath - JSONPath expression to select part of the state to be the output to this state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Returns:

this

build

@Stability(Stable)
public SnsPublishJsonPathProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<SnsPublishJsonPathProps>

Returns:

a new instance of SnsPublishJsonPathProps

Throws:

NullPointerException - if any required attribute was not provided