Interface CfnTopicRule.IIotEventsActionProperty
Sends an input to an AWS IoT Events detector.
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IIotEventsActionProperty
Syntax (vb)
Public Interface IIotEventsActionProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoT;
var iotEventsActionProperty = new IotEventsActionProperty {
InputName = "inputName",
RoleArn = "roleArn",
// the properties below are optional
BatchMode = false,
MessageId = "messageId"
};
Synopsis
Properties
BatchMode | Whether to process the event actions as a batch. The default value is |
InputName | The name of the AWS IoT Events input. |
MessageId | The ID of the message. The default |
RoleArn | The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. |
Properties
BatchMode
Whether to process the event actions as a batch. The default value is false
.
virtual object BatchMode { get; }
Property Value
System.Object
Remarks
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.
InputName
The name of the AWS IoT Events input.
string InputName { get; }
Property Value
System.String
Remarks
MessageId
The ID of the message. The default messageId
is a new UUID value.
virtual string MessageId { get; }
Property Value
System.String
Remarks
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.
RoleArn
The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector.
string RoleArn { get; }
Property Value
System.String
Remarks
("Action":"iotevents:BatchPutMessage").