interface SnsActionProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.IoT.Mixins.CfnTopicRulePropsMixin.SnsActionProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiot/mixins#CfnTopicRulePropsMixin_SnsActionProperty
Java	software.amazon.awscdk.mixins.preview.services.iot.mixins.CfnTopicRulePropsMixin.SnsActionProperty
Python	aws_cdk.mixins_preview.aws_iot.mixins.CfnTopicRulePropsMixin.SnsActionProperty
TypeScript	@aws-cdk/mixins-preview » aws_iot » mixins » CfnTopicRulePropsMixin » SnsActionProperty

Describes an action to publish to an Amazon SNS topic.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as iot_mixins } from '@aws-cdk/mixins-preview/aws-iot';
const snsActionProperty: iot_mixins.CfnTopicRulePropsMixin.SnsActionProperty = {
  messageFormat: 'messageFormat',
  roleArn: 'roleArn',
  targetArn: 'targetArn',
};

Properties

Name	Type	Description
messageFormat?	string	(Optional) The message format of the message to publish.
roleArn?	string	The ARN of the IAM role that grants access.
targetArn?	string	The ARN of the SNS topic.

---

messageFormat?

Type: string (optional)

(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

---

roleArn?

Type: string (optional)

The ARN of the IAM role that grants access.

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

---

targetArn?

Type: string (optional)

The ARN of the SNS topic.

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