software.amazon.awscdk.services.stepfunctions.tasks

Class PublishToTopic.Builder

java.lang.Object

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

Enclosing class:

PublishToTopic

@Stability(value=Experimental)
public static final class PublishToTopic.Builder
extends Object

A fluent builder for PublishToTopic.

Method Summary

Modifier and Type	Method and Description
PublishToTopic	build()
static PublishToTopic.Builder	create(ITopic topic) EXPERIMENTAL
PublishToTopic.Builder	integrationPattern(ServiceIntegrationPattern integrationPattern) The service integration pattern indicates different ways to call Publish to SNS.
PublishToTopic.Builder	message(TaskInput message) The text message to send to the topic.
PublishToTopic.Builder	messagePerSubscriptionType(Boolean messagePerSubscriptionType) If true, send a different message to every subscription type.
PublishToTopic.Builder	subject(String subject) Message subject.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static PublishToTopic.Builder create(ITopic topic)

EXPERIMENTAL

Parameters:

topic - This parameter is required.

Returns:

a new instance of PublishToTopic.Builder.

message

@Stability(value=Experimental)
public PublishToTopic.Builder message(TaskInput message)

The text message to send to the topic.

EXPERIMENTAL

Parameters:

message - The text message to send to the topic. This parameter is required.

Returns:

this

integrationPattern

@Stability(value=Experimental)
public PublishToTopic.Builder integrationPattern(ServiceIntegrationPattern integrationPattern)

The service integration pattern indicates different ways to call Publish to SNS.

The valid value is either FIRE_AND_FORGET or WAIT_FOR_TASK_TOKEN.

Default: FIRE_AND_FORGET

EXPERIMENTAL

Parameters:

integrationPattern - The service integration pattern indicates different ways to call Publish to SNS. This parameter is required.

Returns:

this

messagePerSubscriptionType

@Stability(value=Experimental)
public PublishToTopic.Builder messagePerSubscriptionType(Boolean messagePerSubscriptionType)

If true, send a different message to every subscription type.

If this is set to true, message must be a JSON object with a "default" key and a key for every subscription type (such as "sqs", "email", etc.) The values are strings representing the messages being sent to every subscription type.

EXPERIMENTAL

Parameters:

messagePerSubscriptionType - If true, send a different message to every subscription type. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/sns/latest/api/API_Publish.html#API_Publish_RequestParameters

subject

@Stability(value=Experimental)
public PublishToTopic.Builder subject(String subject)

Message subject.

EXPERIMENTAL

Parameters:

subject - Message subject. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public PublishToTopic build()