Interface SnsTopicActionProps
- All Superinterfaces:
CommonActionProps
,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
SnsTopicActionProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-22T02:24:11.978Z")
@Stability(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
Modifier and TypeInterfaceDescriptionstatic final class
A builder forSnsTopicActionProps
static final class
An implementation forSnsTopicActionProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic SnsTopicActionProps.Builder
builder()
default SnsActionMessageFormat
(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 Details
-
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:
-
builder
- Returns:
- a
SnsTopicActionProps.Builder
ofSnsTopicActionProps
-