interface SnsActionProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.IoT.CfnTopicRule.SnsActionProperty |
 Java | software.amazon.awscdk.services.iot.CfnTopicRule.SnsActionProperty |
 Python | aws_cdk.aws_iot.CfnTopicRule.SnsActionProperty |
 TypeScript | @aws-cdk/aws-iot » CfnTopicRule » SnsActionProperty |
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 * as iot from '@aws-cdk/aws-iot';
const snsActionProperty: iot.CfnTopicRule.SnsActionProperty = {
roleArn: 'roleArn',
targetArn: 'targetArn',
// the properties below are optional
messageFormat: 'messageFormat',
};
Properties
| Name | Type | Description |
|---|---|---|
| role | string | The ARN of the IAM role that grants access. |
| target | string | The ARN of the SNS topic. |
| message | string | (Optional) The message format of the message to publish. |
roleArn
Type:
string
The ARN of the IAM role that grants access.
targetArn
Type:
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 .