Class CfnDetectorModel.ActionProperty
An action to be performed when the condition
is TRUE.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.IoTEvents
Assembly: Amazon.CDK.AWS.IoTEvents.dll
Syntax (csharp)
public class ActionProperty : Object, CfnDetectorModel.IActionProperty
Syntax (vb)
Public Class ActionProperty
Inherits Object
Implements CfnDetectorModel.IActionProperty
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.IoTEvents;
var actionProperty = new ActionProperty {
ClearTimer = new ClearTimerProperty {
TimerName = "timerName"
},
DynamoDb = new DynamoDBProperty {
HashKeyField = "hashKeyField",
HashKeyValue = "hashKeyValue",
TableName = "tableName",
// the properties below are optional
HashKeyType = "hashKeyType",
Operation = "operation",
Payload = new PayloadProperty {
ContentExpression = "contentExpression",
Type = "type"
},
PayloadField = "payloadField",
RangeKeyField = "rangeKeyField",
RangeKeyType = "rangeKeyType",
RangeKeyValue = "rangeKeyValue"
},
DynamoDBv2 = new DynamoDBv2Property {
TableName = "tableName",
// the properties below are optional
Payload = new PayloadProperty {
ContentExpression = "contentExpression",
Type = "type"
}
},
Firehose = new FirehoseProperty {
DeliveryStreamName = "deliveryStreamName",
// the properties below are optional
Payload = new PayloadProperty {
ContentExpression = "contentExpression",
Type = "type"
},
Separator = "separator"
},
IotEvents = new IotEventsProperty {
InputName = "inputName",
// the properties below are optional
Payload = new PayloadProperty {
ContentExpression = "contentExpression",
Type = "type"
}
},
IotSiteWise = new IotSiteWiseProperty {
PropertyValue = new AssetPropertyValueProperty {
Value = new AssetPropertyVariantProperty {
BooleanValue = "booleanValue",
DoubleValue = "doubleValue",
IntegerValue = "integerValue",
StringValue = "stringValue"
},
// the properties below are optional
Quality = "quality",
Timestamp = new AssetPropertyTimestampProperty {
TimeInSeconds = "timeInSeconds",
// the properties below are optional
OffsetInNanos = "offsetInNanos"
}
},
// the properties below are optional
AssetId = "assetId",
EntryId = "entryId",
PropertyAlias = "propertyAlias",
PropertyId = "propertyId"
},
IotTopicPublish = new IotTopicPublishProperty {
MqttTopic = "mqttTopic",
// the properties below are optional
Payload = new PayloadProperty {
ContentExpression = "contentExpression",
Type = "type"
}
},
Lambda = new LambdaProperty {
FunctionArn = "functionArn",
// the properties below are optional
Payload = new PayloadProperty {
ContentExpression = "contentExpression",
Type = "type"
}
},
ResetTimer = new ResetTimerProperty {
TimerName = "timerName"
},
SetTimer = new SetTimerProperty {
TimerName = "timerName",
// the properties below are optional
DurationExpression = "durationExpression",
Seconds = 123
},
SetVariable = new SetVariableProperty {
Value = "value",
VariableName = "variableName"
},
Sns = new SnsProperty {
TargetArn = "targetArn",
// the properties below are optional
Payload = new PayloadProperty {
ContentExpression = "contentExpression",
Type = "type"
}
},
Sqs = new SqsProperty {
QueueUrl = "queueUrl",
// the properties below are optional
Payload = new PayloadProperty {
ContentExpression = "contentExpression",
Type = "type"
},
UseBase64 = false
}
};
Synopsis
Constructors
ActionProperty() |
Properties
ClearTimer | Information needed to clear the timer. |
DynamoDb | Writes to the DynamoDB table that you created. |
DynamoDBv2 | Writes to the DynamoDB table that you created. |
Firehose | Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream. |
IotEvents | Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action. |
IotSiteWise | Sends information about the detector model instance and the event that triggered the action to an asset property in AWS IoT SiteWise . |
IotTopicPublish | Publishes an MQTT message with the given topic to the AWS IoT message broker. |
Lambda | Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action. |
ResetTimer | Information needed to reset the timer. |
SetTimer | Information needed to set the timer. |
SetVariable | Sets a variable to a specified value. |
Sns | Sends an Amazon SNS message. |
Sqs | Sends an Amazon SNS message. |
Constructors
ActionProperty()
public ActionProperty()
Properties
ClearTimer
Information needed to clear the timer.
public object ClearTimer { get; set; }
Property Value
System.Object
Remarks
DynamoDb
Writes to the DynamoDB table that you created.
public object DynamoDb { get; set; }
Property Value
System.Object
Remarks
The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the payload . One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide .
DynamoDBv2
Writes to the DynamoDB table that you created.
public object DynamoDBv2 { get; set; }
Property Value
System.Object
Remarks
The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the payload . A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide .
Firehose
Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
public object Firehose { get; set; }
Property Value
System.Object
Remarks
IotEvents
Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action.
public object IotEvents { get; set; }
Property Value
System.Object
Remarks
IotSiteWise
Sends information about the detector model instance and the event that triggered the action to an asset property in AWS IoT SiteWise .
public object IotSiteWise { get; set; }
Property Value
System.Object
Remarks
IotTopicPublish
Publishes an MQTT message with the given topic to the AWS IoT message broker.
public object IotTopicPublish { get; set; }
Property Value
System.Object
Remarks
Lambda
Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
public object Lambda { get; set; }
Property Value
System.Object
Remarks
ResetTimer
Information needed to reset the timer.
public object ResetTimer { get; set; }
Property Value
System.Object
Remarks
SetTimer
Information needed to set the timer.
public object SetTimer { get; set; }
Property Value
System.Object
Remarks
SetVariable
Sets a variable to a specified value.
public object SetVariable { get; set; }
Property Value
System.Object
Remarks
Sns
Sends an Amazon SNS message.
public object Sns { get; set; }
Property Value
System.Object
Remarks
Sqs
Sends an Amazon SNS message.
public object Sqs { get; set; }
Property Value
System.Object