interface IotAnalyticsActionProperty

Language	Type name
.NET	`Amazon.CDK.CfnPropertyMixins.AWS.IoT.CfnTopicRulePropsMixin.IotAnalyticsActionProperty`
Go	`github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsiot#CfnTopicRulePropsMixin_IotAnalyticsActionProperty`
Java	`software.amazon.awscdk.cfnpropertymixins.services.iot.CfnTopicRulePropsMixin.IotAnalyticsActionProperty`
Python	`aws_cdk.cfn_property_mixins.aws_iot.CfnTopicRulePropsMixin.IotAnalyticsActionProperty`
TypeScript	`@aws-cdk/cfn-property-mixins` » `aws_iot` » `CfnTopicRulePropsMixin` » `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/cfn-property-mixins';
const iotAnalyticsActionProperty: iot.CfnTopicRulePropsMixin.IotAnalyticsActionProperty = {
  batchMode: false,
  channelName: 'channelName',
  roleArn: 'roleArn',
};

Properties

Name	Type	Description
batchMode?	`boolean \|` `IResolvable`	Whether to process the action as a batch. The default value is `false` .
channelName?	`string`	The name of the IoT Analytics channel to which message data will be sent.
roleArn?	`string \|` `IRoleRef`	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.

channelName?

Type: string (optional)

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

roleArn?

Type: string | IRoleRef (optional)

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

AWS CDK