interface ActionProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.IoTEvents.CfnDetectorModel.ActionProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsiotevents#CfnDetectorModel_ActionProperty |
![]() | software.amazon.awscdk.services.iotevents.CfnDetectorModel.ActionProperty |
![]() | aws_cdk.aws_iotevents.CfnDetectorModel.ActionProperty |
![]() | aws-cdk-lib » aws_iotevents » CfnDetectorModel » ActionProperty |
An action to be performed when the condition
is TRUE.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iotevents as iotevents } from 'aws-cdk-lib';
const actionProperty: iotevents.CfnDetectorModel.ActionProperty = {
clearTimer: {
timerName: 'timerName',
},
dynamoDb: {
hashKeyField: 'hashKeyField',
hashKeyValue: 'hashKeyValue',
tableName: 'tableName',
// the properties below are optional
hashKeyType: 'hashKeyType',
operation: 'operation',
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
payloadField: 'payloadField',
rangeKeyField: 'rangeKeyField',
rangeKeyType: 'rangeKeyType',
rangeKeyValue: 'rangeKeyValue',
},
dynamoDBv2: {
tableName: 'tableName',
// the properties below are optional
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
},
firehose: {
deliveryStreamName: 'deliveryStreamName',
// the properties below are optional
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
separator: 'separator',
},
iotEvents: {
inputName: 'inputName',
// the properties below are optional
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
},
iotSiteWise: {
propertyValue: {
value: {
booleanValue: 'booleanValue',
doubleValue: 'doubleValue',
integerValue: 'integerValue',
stringValue: 'stringValue',
},
// the properties below are optional
quality: 'quality',
timestamp: {
timeInSeconds: 'timeInSeconds',
// the properties below are optional
offsetInNanos: 'offsetInNanos',
},
},
// the properties below are optional
assetId: 'assetId',
entryId: 'entryId',
propertyAlias: 'propertyAlias',
propertyId: 'propertyId',
},
iotTopicPublish: {
mqttTopic: 'mqttTopic',
// the properties below are optional
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
},
lambda: {
functionArn: 'functionArn',
// the properties below are optional
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
},
resetTimer: {
timerName: 'timerName',
},
setTimer: {
timerName: 'timerName',
// the properties below are optional
durationExpression: 'durationExpression',
seconds: 123,
},
setVariable: {
value: 'value',
variableName: 'variableName',
},
sns: {
targetArn: 'targetArn',
// the properties below are optional
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
},
sqs: {
queueUrl: 'queueUrl',
// the properties below are optional
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
useBase64: false,
},
};
Properties
Name | Type | Description |
---|---|---|
clear | IResolvable | Clear | Information needed to clear the timer. |
dynamo | IResolvable | Dynamo | Writes to the DynamoDB table that you created. |
dynamo | IResolvable | Dynamo | Writes to the DynamoDB table that you created. |
firehose? | IResolvable | Firehose | Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream. |
iot | IResolvable | Iot | Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action. |
iot | IResolvable | Iot | Sends information about the detector model instance and the event that triggered the action to an asset property in AWS IoT SiteWise . |
iot | IResolvable | Iot | Publishes an MQTT message with the given topic to the AWS IoT message broker. |
lambda? | IResolvable | Lambda | Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action. |
reset | IResolvable | Reset | Information needed to reset the timer. |
set | IResolvable | Set | Information needed to set the timer. |
set | IResolvable | Set | Sets a variable to a specified value. |
sns? | IResolvable | Sns | Sends an Amazon SNS message. |
sqs? | IResolvable | Sqs | Sends an Amazon SNS message. |
clearTimer?
Type:
IResolvable
|
Clear
(optional)
Information needed to clear the timer.
dynamoDBv2?
Type:
IResolvable
|
Dynamo
(optional)
Writes to the DynamoDB table that you created.
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 .
dynamoDb?
Type:
IResolvable
|
Dynamo
(optional)
Writes to the DynamoDB table that you created.
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 .
firehose?
Type:
IResolvable
|
Firehose
(optional)
Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
iotEvents?
Type:
IResolvable
|
Iot
(optional)
Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action.
iotSiteWise?
Type:
IResolvable
|
Iot
(optional)
Sends information about the detector model instance and the event that triggered the action to an asset property in AWS IoT SiteWise .
iotTopicPublish?
Type:
IResolvable
|
Iot
(optional)
Publishes an MQTT message with the given topic to the AWS IoT message broker.
lambda?
Type:
IResolvable
|
Lambda
(optional)
Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
resetTimer?
Type:
IResolvable
|
Reset
(optional)
Information needed to reset the timer.
setTimer?
Type:
IResolvable
|
Set
(optional)
Information needed to set the timer.
setVariable?
Type:
IResolvable
|
Set
(optional)
Sets a variable to a specified value.
sns?
Type:
IResolvable
|
Sns
(optional)
Sends an Amazon SNS message.
sqs?
Type:
IResolvable
|
Sqs
(optional)
Sends an Amazon SNS message.