Package software.amazon.awscdk.services.iotevents

Interface CfnDetectorModelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDetectorModelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-05-20T23:52:57.860Z")
@Stability(Stable)
public interface CfnDetectorModelProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDetectorModel.

Example:

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDetectorModelProps.Builder	A builder for CfnDetectorModelProps
static final class	CfnDetectorModelProps.Jsii$Proxy	An implementation for CfnDetectorModelProps

Method Summary

Modifier and Type	Method	Description
static CfnDetectorModelProps.Builder	builder()
Object	getDetectorModelDefinition()	Information that defines how a detector operates.
default String	getDetectorModelDescription()	A brief description of the detector model.
default String	getDetectorModelName()	The name of the detector model.
default String	getEvaluationMethod()	Information about the order in which events are evaluated and how actions are executed.
default String	getKey()	The value used to identify a detector instance.
String	getRoleArn()	The ARN of the role that grants permission to AWS IoT Events to perform its operations.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDetectorModelDefinition

@Stability(Stable)
@NotNull
Object getDetectorModelDefinition()

Information that defines how a detector operates.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-detectormodeldefinition

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-rolearn

getDetectorModelDescription

@Stability(Stable)
@Nullable
default String getDetectorModelDescription()

A brief description of the detector model.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-detectormodeldescription

getDetectorModelName

@Stability(Stable)
@Nullable
default String getDetectorModelName()

The name of the detector model.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-detectormodelname

getEvaluationMethod

@Stability(Stable)
@Nullable
default String getEvaluationMethod()

Information about the order in which events are evaluated and how actions are executed.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-evaluationmethod

getKey

@Stability(Stable)
@Nullable
default String getKey()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-key

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

For more information, see Tag .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-tags

builder

@Stability(Stable)
static CfnDetectorModelProps.Builder builder()

Returns:

a CfnDetectorModelProps.Builder of CfnDetectorModelProps