aws-cdk-lib.aws_iot.CfnTopicRule.IotAnalyticsActionProperty

interface IotAnalyticsActionProperty

LanguageType name
.NETAmazon.CDK.AWS.IoT.CfnTopicRule.IotAnalyticsActionProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnTopicRule_IotAnalyticsActionProperty
Javasoftware.amazon.awscdk.services.iot.CfnTopicRule.IotAnalyticsActionProperty
Pythonaws_cdk.aws_iot.CfnTopicRule.IotAnalyticsActionProperty
TypeScript aws-cdk-lib » aws_iot » CfnTopicRule » IotAnalyticsActionProperty

Sends message data to an AWS IoT Analytics channel.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iot as iot } from 'aws-cdk-lib';
const iotAnalyticsActionProperty: iot.CfnTopicRule.IotAnalyticsActionProperty = {
  channelName: 'channelName',
  roleArn: 'roleArn',

  // the properties below are optional
  batchMode: false,
};

Properties

NameTypeDescription
channelNamestringThe name of the IoT Analytics channel to which message data will be sent.
roleArnstringThe ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
batchMode?boolean | IResolvableWhether to process the action as a batch. The default value is false .

channelName

Type: string

The name of the IoT Analytics channel to which message data will be sent.


roleArn

Type: string

The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).


batchMode?

Type: boolean | IResolvable (optional)

Whether to process the action as a batch. The default value is false .

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage The resulting array can't have more than 100 messages.