interface IotEventsActionProperty

Language	Type name
.NET	`Amazon.CDK.AWS.IoT.CfnTopicRule.IotEventsActionProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnTopicRule_IotEventsActionProperty`
Java	`software.amazon.awscdk.services.iot.CfnTopicRule.IotEventsActionProperty`
Python	`aws_cdk.aws_iot.CfnTopicRule.IotEventsActionProperty`
TypeScript	`aws-cdk-lib` » `aws_iot` » `CfnTopicRule` » `IotEventsActionProperty`

Sends an input to an AWS IoT Events detector.

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 iotEventsActionProperty: iot.CfnTopicRule.IotEventsActionProperty = {
  inputName: 'inputName',
  roleArn: 'roleArn',

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

Properties

Name	Type	Description
inputName	`string`	The name of the AWS IoT Events input.
roleArn	`string`	The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector.
batchMode?	`boolean \|` `IResolvable`	Whether to process the event actions as a batch. The default value is `false` .
messageId?	`string`	The ID of the message. The default `messageId` is a new UUID value.

inputName

Type: string

The name of the AWS IoT Events input.

roleArn

Type: string

The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector.

("Action":"iotevents:BatchPutMessage").

batchMode?

Type: boolean | IResolvable (optional)

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

When batchMode is true , you can't specify a messageId .

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

messageId?

Type: string (optional)

The ID of the message. The default messageId is a new UUID value.

When batchMode is true , you can't specify a messageId --a new UUID value will be assigned.

Assign a value to this property to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector.