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

Class SnsPublishProps.Builder

java.lang.Object
software.amazon.awscdk.services.stepfunctions.tasks.SnsPublishProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<SnsPublishProps>
Enclosing interface:
SnsPublishProps
@Stability(Stable) public static final class SnsPublishProps.Builder extends Object implements software.amazon.jsii.Builder<SnsPublishProps>
A builder for SnsPublishProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • message

      @Stability(Stable) public SnsPublishProps.Builder message(TaskInput message)
      Sets the value of SnsPublishProps.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 SnsPublishProps.Builder topic(ITopic topic)
      Sets the value of SnsPublishProps.getTopic()
      Parameters:
      topic - The SNS topic that the task will publish to. This parameter is required.
      Returns:
      this

    • messageAttributes

      @Stability(Stable) public SnsPublishProps.Builder messageAttributes(Map<String,? extends MessageAttribute> messageAttributes)
      Sets the value of SnsPublishProps.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 SnsPublishProps.Builder messageDeduplicationId(String messageDeduplicationId)
      Sets the value of SnsPublishProps.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 SnsPublishProps.Builder messageGroupId(String messageGroupId)
      Sets the value of SnsPublishProps.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 SnsPublishProps.Builder messagePerSubscriptionType(Boolean messagePerSubscriptionType)
      Sets the value of SnsPublishProps.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 SnsPublishProps.Builder subject(String subject)
      Sets the value of SnsPublishProps.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

    • comment

      @Stability(Stable) public SnsPublishProps.Builder comment(String comment)
      Sets the value of TaskStateBaseProps.getComment()
      Parameters:
      comment - An optional description for this state.
      Returns:
      this

    • credentials

      @Stability(Stable) public SnsPublishProps.Builder credentials(Credentials credentials)
      Sets the value of TaskStateBaseProps.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 SnsPublishProps.Builder heartbeat(Duration heartbeat)
      Deprecated.
      use `heartbeatTimeout`
      Sets the value of TaskStateBaseProps.getHeartbeat()
      Parameters:
      heartbeat - Timeout for the heartbeat.
      Returns:
      this

    • heartbeatTimeout

      @Stability(Stable) public SnsPublishProps.Builder heartbeatTimeout(Timeout heartbeatTimeout)
      Sets the value of TaskStateBaseProps.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

    • inputPath

      @Stability(Stable) public SnsPublishProps.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(Stable) public SnsPublishProps.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.

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

      Returns:
      this

    • outputPath

      @Stability(Stable) public SnsPublishProps.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(Stable) public SnsPublishProps.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(Stable) public SnsPublishProps.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

    • stateName

      @Stability(Stable) public SnsPublishProps.Builder stateName(String stateName)
      Sets the value of TaskStateBaseProps.getStateName()
      Parameters:
      stateName - Optional name for this state.
      Returns:
      this

    • taskTimeout

      @Stability(Stable) public SnsPublishProps.Builder taskTimeout(Timeout taskTimeout)
      Sets the value of TaskStateBaseProps.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 SnsPublishProps.Builder timeout(Duration timeout)
      Deprecated.
      use `taskTimeout`
      Sets the value of TaskStateBaseProps.getTimeout()
      Parameters:
      timeout - Timeout for the task.
      Returns:
      this

    • build

      @Stability(Stable) public SnsPublishProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<SnsPublishProps>
      Returns:
      a new instance of SnsPublishProps
      Throws:
      NullPointerException - if any required attribute was not provided