interface CfnDetectorModelMixinProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.Mixins.Preview.AWS.IoTEvents.Mixins.CfnDetectorModelMixinProps |
 Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiotevents/mixins#CfnDetectorModelMixinProps |
 Java | software.amazon.awscdk.mixins.preview.services.iotevents.mixins.CfnDetectorModelMixinProps |
 Python | aws_cdk.mixins_preview.aws_iotevents.mixins.CfnDetectorModelMixinProps |
 TypeScript | @aws-cdk/mixins-preview » aws_iotevents » mixins » CfnDetectorModelMixinProps |
Properties for CfnDetectorModelPropsMixin.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as iotevents_mixins } from '@aws-cdk/mixins-preview/aws-iotevents';
const cfnDetectorModelMixinProps: iotevents_mixins.CfnDetectorModelMixinProps = {
detectorModelDefinition: {
initialStateName: 'initialStateName',
states: [{
onEnter: {
events: [{
actions: [{
clearTimer: {
timerName: 'timerName',
},
dynamoDb: {
hashKeyField: 'hashKeyField',
hashKeyType: 'hashKeyType',
hashKeyValue: 'hashKeyValue',
operation: 'operation',
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
payloadField: 'payloadField',
rangeKeyField: 'rangeKeyField',
rangeKeyType: 'rangeKeyType',
rangeKeyValue: 'rangeKeyValue',
tableName: 'tableName',
},
dynamoDBv2: {
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
tableName: 'tableName',
},
firehose: {
deliveryStreamName: 'deliveryStreamName',
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
separator: 'separator',
},
iotEvents: {
inputName: 'inputName',
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
},
iotSiteWise: {
assetId: 'assetId',
entryId: 'entryId',
propertyAlias: 'propertyAlias',
propertyId: 'propertyId',
propertyValue: {
quality: 'quality',
timestamp: {
offsetInNanos: 'offsetInNanos',
timeInSeconds: 'timeInSeconds',
},
value: {
booleanValue: 'booleanValue',
doubleValue: 'doubleValue',
integerValue: 'integerValue',
stringValue: 'stringValue',
},
},
},
iotTopicPublish: {
mqttTopic: 'mqttTopic',
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
},
lambda: {
functionArn: 'functionArn',
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
},
resetTimer: {
timerName: 'timerName',
},
setTimer: {
durationExpression: 'durationExpression',
seconds: 123,
timerName: 'timerName',
},
setVariable: {
value: 'value',
variableName: 'variableName',
},
sns: {
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
targetArn: 'targetArn',
},
sqs: {
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
queueUrl: 'queueUrl',
useBase64: false,
},
}],
condition: 'condition',
eventName: 'eventName',
}],
},
onExit: {
events: [{
actions: [{
clearTimer: {
timerName: 'timerName',
},
dynamoDb: {
hashKeyField: 'hashKeyField',
hashKeyType: 'hashKeyType',
hashKeyValue: 'hashKeyValue',
operation: 'operation',
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
payloadField: 'payloadField',
rangeKeyField: 'rangeKeyField',
rangeKeyType: 'rangeKeyType',
rangeKeyValue: 'rangeKeyValue',
tableName: 'tableName',
},
dynamoDBv2: {
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
tableName: 'tableName',
},
firehose: {
deliveryStreamName: 'deliveryStreamName',
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
separator: 'separator',
},
iotEvents: {
inputName: 'inputName',
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
},
iotSiteWise: {
assetId: 'assetId',
entryId: 'entryId',
propertyAlias: 'propertyAlias',
propertyId: 'propertyId',
propertyValue: {
quality: 'quality',
timestamp: {
offsetInNanos: 'offsetInNanos',
timeInSeconds: 'timeInSeconds',
},
value: {
booleanValue: 'booleanValue',
doubleValue: 'doubleValue',
integerValue: 'integerValue',
stringValue: 'stringValue',
},
},
},
iotTopicPublish: {
mqttTopic: 'mqttTopic',
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
},
lambda: {
functionArn: 'functionArn',
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
},
resetTimer: {
timerName: 'timerName',
},
setTimer: {
durationExpression: 'durationExpression',
seconds: 123,
timerName: 'timerName',
},
setVariable: {
value: 'value',
variableName: 'variableName',
},
sns: {
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
targetArn: 'targetArn',
},
sqs: {
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
queueUrl: 'queueUrl',
useBase64: false,
},
}],
condition: 'condition',
eventName: 'eventName',
}],
},
onInput: {
events: [{
actions: [{
clearTimer: {
timerName: 'timerName',
},
dynamoDb: {
hashKeyField: 'hashKeyField',
hashKeyType: 'hashKeyType',
hashKeyValue: 'hashKeyValue',
operation: 'operation',
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
payloadField: 'payloadField',
rangeKeyField: 'rangeKeyField',
rangeKeyType: 'rangeKeyType',
rangeKeyValue: 'rangeKeyValue',
tableName: 'tableName',
},
dynamoDBv2: {
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
tableName: 'tableName',
},
firehose: {
deliveryStreamName: 'deliveryStreamName',
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
separator: 'separator',
},
iotEvents: {
inputName: 'inputName',
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
},
iotSiteWise: {
assetId: 'assetId',
entryId: 'entryId',
propertyAlias: 'propertyAlias',
propertyId: 'propertyId',
propertyValue: {
quality: 'quality',
timestamp: {
offsetInNanos: 'offsetInNanos',
timeInSeconds: 'timeInSeconds',
},
value: {
booleanValue: 'booleanValue',
doubleValue: 'doubleValue',
integerValue: 'integerValue',
stringValue: 'stringValue',
},
},
},
iotTopicPublish: {
mqttTopic: 'mqttTopic',
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
},
lambda: {
functionArn: 'functionArn',
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
},
resetTimer: {
timerName: 'timerName',
},
setTimer: {
durationExpression: 'durationExpression',
seconds: 123,
timerName: 'timerName',
},
setVariable: {
value: 'value',
variableName: 'variableName',
},
sns: {
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
targetArn: 'targetArn',
},
sqs: {
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
queueUrl: 'queueUrl',
useBase64: false,
},
}],
condition: 'condition',
eventName: 'eventName',
}],
transitionEvents: [{
actions: [{
clearTimer: {
timerName: 'timerName',
},
dynamoDb: {
hashKeyField: 'hashKeyField',
hashKeyType: 'hashKeyType',
hashKeyValue: 'hashKeyValue',
operation: 'operation',
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
payloadField: 'payloadField',
rangeKeyField: 'rangeKeyField',
rangeKeyType: 'rangeKeyType',
rangeKeyValue: 'rangeKeyValue',
tableName: 'tableName',
},
dynamoDBv2: {
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
tableName: 'tableName',
},
firehose: {
deliveryStreamName: 'deliveryStreamName',
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
separator: 'separator',
},
iotEvents: {
inputName: 'inputName',
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
},
iotSiteWise: {
assetId: 'assetId',
entryId: 'entryId',
propertyAlias: 'propertyAlias',
propertyId: 'propertyId',
propertyValue: {
quality: 'quality',
timestamp: {
offsetInNanos: 'offsetInNanos',
timeInSeconds: 'timeInSeconds',
},
value: {
booleanValue: 'booleanValue',
doubleValue: 'doubleValue',
integerValue: 'integerValue',
stringValue: 'stringValue',
},
},
},
iotTopicPublish: {
mqttTopic: 'mqttTopic',
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
},
lambda: {
functionArn: 'functionArn',
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
},
resetTimer: {
timerName: 'timerName',
},
setTimer: {
durationExpression: 'durationExpression',
seconds: 123,
timerName: 'timerName',
},
setVariable: {
value: 'value',
variableName: 'variableName',
},
sns: {
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
targetArn: 'targetArn',
},
sqs: {
payload: {
contentExpression: 'contentExpression',
type: 'type',
},
queueUrl: 'queueUrl',
useBase64: false,
},
}],
condition: 'condition',
eventName: 'eventName',
nextState: 'nextState',
}],
},
stateName: 'stateName',
}],
},
detectorModelDescription: 'detectorModelDescription',
detectorModelName: 'detectorModelName',
evaluationMethod: 'evaluationMethod',
key: 'key',
roleArn: 'roleArn',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
| Name | Type | Description |
|---|---|---|
| detector | IResolvable | Detector | Information that defines how a detector operates. |
| detector | string | A brief description of the detector model. |
| detector | string | The name of the detector model. |
| evaluation | string | Information about the order in which events are evaluated and how actions are executed. |
| key? | string | The value used to identify a detector instance. |
| role | string | The ARN of the role that grants permission to AWS IoT Events to perform its operations. |
| tags? | Cfn[] | An array of key-value pairs to apply to this resource. |
detectorModelDefinition?
Type:
IResolvable | Detector
(optional)
Information that defines how a detector operates.
detectorModelDescription?
Type:
string
(optional)
A brief description of the detector model.
detectorModelName?
Type:
string
(optional)
The name of the detector model.
evaluationMethod?
Type:
string
(optional)
Information about the order in which events are evaluated and how actions are executed.
key?
Type:
string
(optional)
The value used to identify a detector instance.
When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information.
This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.
roleArn?
Type:
string
(optional)
The ARN of the role that grants permission to AWS IoT Events to perform its operations.
tags?
Type:
Cfn[]
(optional)
An array of key-value pairs to apply to this resource.
For more information, see Tag .