Package software.amazon.awscdk.services.iot

Interface CfnTopicRule.SnsActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRule.SnsActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRule

@Stability(Stable)
public static interface CfnTopicRule.SnsActionProperty
extends software.amazon.jsii.JsiiSerializable

Describes an action to publish to an Amazon SNS topic.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iot.*;
 SnsActionProperty snsActionProperty = SnsActionProperty.builder()
         .roleArn("roleArn")
         .targetArn("targetArn")
         // the properties below are optional
         .messageFormat("messageFormat")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTopicRule.SnsActionProperty.Builder	builder()
default String	getMessageFormat()	(Optional) The message format of the message to publish.
String	getRoleArn()	The ARN of the IAM role that grants access.
String	getTargetArn()	The ARN of the SNS topic.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The ARN of the IAM role that grants access.

getTargetArn

@Stability(Stable)
@NotNull
String getTargetArn()

The ARN of the SNS topic.

getMessageFormat

@Stability(Stable)
@Nullable
default String getMessageFormat()

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

Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. For more information, see Amazon SNS Message and JSON Formats in the Amazon Simple Notification Service Developer Guide .

builder

@Stability(Stable)
static CfnTopicRule.SnsActionProperty.Builder builder()

Returns:

a CfnTopicRule.SnsActionProperty.Builder of CfnTopicRule.SnsActionProperty