software.amazon.awscdk.services.iot.actions.alpha

Interface SnsTopicActionProps

All Superinterfaces:

CommonActionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SnsTopicActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.78.1 (build 878761e)",
           date="2023-04-17T22:38:13.264Z")
 @Stability(value=Experimental)
public interface SnsTopicActionProps
extends software.amazon.jsii.JsiiSerializable, CommonActionProps

(experimental) Configuration options for the SNS topic action.

Example:

 import software.amazon.awscdk.services.sns.*;
 Topic topic = new Topic(this, "MyTopic");
 TopicRule topicRule = TopicRule.Builder.create(this, "TopicRule")
         .sql(IotSql.fromStringAsVer20160323("SELECT topic(2) as device_id, year, month, day FROM 'device/+/data'"))
         .actions(List.of(
             SnsTopicAction.Builder.create(topic)
                     .messageFormat(SnsActionMessageFormat.JSON)
                     .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SnsTopicActionProps.Builder A builder for SnsTopicActionProps
static class	SnsTopicActionProps.Jsii$Proxy An implementation for SnsTopicActionProps

Method Summary

Modifier and Type	Method and Description
static SnsTopicActionProps.Builder	builder()
default SnsActionMessageFormat	getMessageFormat() (experimental) The message format of the message to publish.

Methods inherited from interface software.amazon.awscdk.services.iot.actions.alpha.CommonActionProps

getRole

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMessageFormat

@Stability(value=Experimental)
 @Nullable
default SnsActionMessageFormat getMessageFormat()

(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

See Also:

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

builder

@Stability(value=Experimental)
static SnsTopicActionProps.Builder builder()

Specified by:

builder in interface CommonActionProps

Returns:

a SnsTopicActionProps.Builder of SnsTopicActionProps