aws-cdk-lib.aws_iotevents.CfnDetectorModelProps

interface CfnDetectorModelProps

LanguageType name
.NETAmazon.CDK.AWS.IoTEvents.CfnDetectorModelProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiotevents#CfnDetectorModelProps
Javasoftware.amazon.awscdk.services.iotevents.CfnDetectorModelProps
Pythonaws_cdk.aws_iotevents.CfnDetectorModelProps
TypeScript aws-cdk-lib » aws_iotevents » CfnDetectorModelProps

Properties for defining a CfnDetectorModel.

Example

// The generated example for this type would exceed 500 lines,
// and has been elided for readability.

Properties

NameTypeDescription
detectorModelDefinitionIResolvable | DetectorModelDefinitionPropertyInformation that defines how a detector operates.
roleArnstringThe ARN of the role that grants permission to AWS IoT Events to perform its operations.
detectorModelDescription?stringA brief description of the detector model.
detectorModelName?stringThe name of the detector model.
evaluationMethod?stringInformation about the order in which events are evaluated and how actions are executed.
key?stringThe value used to identify a detector instance.
tags?CfnTag[]An array of key-value pairs to apply to this resource.

detectorModelDefinition

Type: IResolvable | DetectorModelDefinitionProperty

Information that defines how a detector operates.


roleArn

Type: string

The ARN of the role that grants permission to AWS IoT Events to perform its operations.


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.


tags?

Type: CfnTag[] (optional)

An array of key-value pairs to apply to this resource.

For more information, see Tag .