Package software.amazon.awscdk.services.iot.actions

Class SnsTopicAction.Builder

java.lang.Object

software.amazon.awscdk.services.iot.actions.SnsTopicAction.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SnsTopicAction>

Enclosing class:

SnsTopicAction

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

(experimental) A fluent builder for SnsTopicAction.

Method Summary

Modifier and Type	Method	Description
SnsTopicAction	build()
static SnsTopicAction.Builder	create(ITopic topic)
SnsTopicAction.Builder	messageFormat(SnsActionMessageFormat messageFormat)	(experimental) The message format of the message to publish.
SnsTopicAction.Builder	role(IRole role)	(experimental) The IAM role that allows access to AWS service.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Experimental)
public static SnsTopicAction.Builder create(ITopic topic)

Parameters:

topic - The Amazon SNS topic to publish data on. This parameter is required.

Returns:

a new instance of SnsTopicAction.Builder.

role

@Stability(Experimental)
public SnsTopicAction.Builder role(IRole role)

(experimental) The IAM role that allows access to AWS service.

Default: a new role will be created

Parameters:

role - The IAM role that allows access to AWS service. This parameter is required.

Returns:

this

messageFormat

@Stability(Experimental)
public SnsTopicAction.Builder messageFormat(SnsActionMessageFormat messageFormat)

(experimental) The message format of the message to publish.

SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted.

Default: SnsActionMessageFormat.RAW

Parameters:

messageFormat - The message format of the message to publish. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/sns/latest/dg/sns-message-and-json-formats.html

build

@Stability(Experimental)
public SnsTopicAction build()

Specified by:

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

Returns:

a newly built instance of SnsTopicAction.