interface IotEventsActionProperty

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

Sends an input to an AWS IoT Events detector.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-ioteventsaction.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 iotEventsActionProperty: iot_mixins.CfnTopicRulePropsMixin.IotEventsActionProperty = {
  batchMode: false,
  inputName: 'inputName',
  messageId: 'messageId',
  roleArn: 'roleArn',
};

Properties

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

---

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.

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

---

inputName?

Type: string (optional)

The name of the AWS IoT Events input.

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

---

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.

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

---

roleArn?

Type: string (optional)

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

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

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