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

Class SnsPublish.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static SnsPublish.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - Descriptive identifier for this chainable. This parameter is required.
      Returns:
      a new instance of SnsPublish.Builder.

    • comment

      @Stability(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

    • credentials

      @Stability(Stable) public SnsPublish.Builder credentials(Credentials credentials)
      Credentials for an IAM Role that the State Machine assumes for executing the task.

      This enables cross-account resource invocations.

      Default: - None (Task is executed using the State Machine's execution role)

      Parameters:
      credentials - Credentials for an IAM Role that the State Machine assumes for executing the task. This parameter is required.
      Returns:
      this
      See Also:

    • heartbeat

      @Stability(Deprecated) @Deprecated public SnsPublish.Builder heartbeat(Duration heartbeat)
      Deprecated.
      use heartbeatTimeout
      (deprecated) Timeout for the heartbeat.

      Default: - None

      Parameters:
      heartbeat - Timeout for the heartbeat. This parameter is required.
      Returns:
      this

    • heartbeatTimeout

      @Stability(Stable) public SnsPublish.Builder heartbeatTimeout(Timeout heartbeatTimeout)
      Timeout for the heartbeat.

      [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

      Default: - None

      Parameters:
      heartbeatTimeout - Timeout for the heartbeat. This parameter is required.
      Returns:
      this

    • inputPath

      @Stability(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(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.

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

      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:

    • outputPath

      @Stability(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(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(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:

    • stateName

      @Stability(Stable) public SnsPublish.Builder stateName(String stateName)
      Optional name for this state.

      Default: - The construct ID will be used as state name

      Parameters:
      stateName - Optional name for this state. This parameter is required.
      Returns:
      this

    • taskTimeout

      @Stability(Stable) public SnsPublish.Builder taskTimeout(Timeout taskTimeout)
      Timeout for the task.

      [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

      Default: - None

      Parameters:
      taskTimeout - Timeout for the task. This parameter is required.
      Returns:
      this

    • timeout

      @Stability(Deprecated) @Deprecated public SnsPublish.Builder timeout(Duration timeout)
      Deprecated.
      use taskTimeout
      (deprecated) Timeout for the task.

      Default: - None

      Parameters:
      timeout - Timeout for the task. This parameter is required.
      Returns:
      this

    • message

      @Stability(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(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(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:

    • messageDeduplicationId

      @Stability(Stable) public SnsPublish.Builder messageDeduplicationId(String 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.

      Default: - Not used for standard topics, required for FIFO topics with ContentBasedDeduplication disabled.

      Parameters:
      messageDeduplicationId - This parameter applies only to FIFO topics. This parameter is required.
      Returns:
      this

    • messageGroupId

      @Stability(Stable) public SnsPublish.Builder messageGroupId(String 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.

      Default: - Not used for standard topics, required for FIFO topics.

      Parameters:
      messageGroupId - This parameter applies only to FIFO topics. This parameter is required.
      Returns:
      this

    • messagePerSubscriptionType

      @Stability(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:

    • subject

      @Stability(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(Stable) public SnsPublish build()
      Specified by:
      build in interface software.amazon.jsii.Builder<SnsPublish>
      Returns:
      a newly built instance of SnsPublish.