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

Class SnsPublishJsonataProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • message

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

    • messageAttributes

      @Stability(Stable) public SnsPublishJsonataProps.Builder messageAttributes(Map<String,? extends MessageAttribute> messageAttributes)
      Sets the value of SnsPublishJsonataProps.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 SnsPublishJsonataProps.Builder messageDeduplicationId(String messageDeduplicationId)
      Sets the value of SnsPublishJsonataProps.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 SnsPublishJsonataProps.Builder messageGroupId(String messageGroupId)
      Sets the value of SnsPublishJsonataProps.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 SnsPublishJsonataProps.Builder messagePerSubscriptionType(Boolean messagePerSubscriptionType)
      Sets the value of SnsPublishJsonataProps.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 SnsPublishJsonataProps.Builder subject(String subject)
      Sets the value of SnsPublishJsonataProps.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 SnsPublishJsonataProps.Builder comment(String comment)
      Sets the value of StateBaseProps.getComment()
      Parameters:
      comment - A comment describing this state.
      Returns:
      this

    • queryLanguage

      @Stability(Stable) public SnsPublishJsonataProps.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 SnsPublishJsonataProps.Builder stateName(String stateName)
      Sets the value of StateBaseProps.getStateName()
      Parameters:
      stateName - Optional name for this state.
      Returns:
      this

    • credentials

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

    • outputs

      @Stability(Stable) public SnsPublishJsonataProps.Builder outputs(Object outputs)
      Sets the value of JsonataCommonOptions.getOutputs()
      Parameters:
      outputs - Used to specify and transform output from the state. When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.
      Returns:
      this

    • build

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