Package software.amazon.awscdk.cfnpropertymixins.services.iot

Interface CfnTopicRulePropsMixin.SnsActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRulePropsMixin.SnsActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRulePropsMixin

@Stability(Stable)
public static interface CfnTopicRulePropsMixin.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.cfnpropertymixins.services.iot.*;
 SnsActionProperty snsActionProperty = SnsActionProperty.builder()
         .messageFormat("messageFormat")
         .roleArn("roleArn")
         .targetArn("targetArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-snsaction.html

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-snsaction.html#cfn-iot-topicrule-snsaction-messageformat

getRoleArn

@Stability(Stable)
@Nullable
default Object getRoleArn()

The ARN of the IAM role that grants access.

Returns union: either String or IRoleRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-snsaction.html#cfn-iot-topicrule-snsaction-rolearn

getTargetArn

@Stability(Stable)
@Nullable
default Object getTargetArn()

The ARN of the SNS topic.

Returns union: either String or ITopicRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-snsaction.html#cfn-iot-topicrule-snsaction-targetarn

builder

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

Returns:

a CfnTopicRulePropsMixin.SnsActionProperty.Builder of CfnTopicRulePropsMixin.SnsActionProperty