CfnDetectorModelProps
- class aws_cdk.aws_iotevents.CfnDetectorModelProps(*, detector_model_definition, role_arn, detector_model_description=None, detector_model_name=None, evaluation_method=None, key=None, tags=None)
Bases:
object
Properties for defining a
CfnDetectorModel
.- Parameters:
detector_model_definition (
Union
[IResolvable
,DetectorModelDefinitionProperty
,Dict
[str
,Any
]]) – Information that defines how a detector operates.role_arn (
str
) – The ARN of the role that grants permission to AWS IoT Events to perform its operations.detector_model_description (
Optional
[str
]) – A brief description of the detector model.detector_model_name (
Optional
[str
]) – The name of the detector model.evaluation_method (
Optional
[str
]) – Information about the order in which events are evaluated and how actions are executed.key (
Optional
[str
]) – 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 (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .
- See:
- ExampleMetadata:
fixture=_generated
Example:
.. rubric:: Attributes
- detector_model_definition
Information that defines how a detector operates.
- detector_model_description
A brief description of the detector model.
- detector_model_name
The name of the detector model.
- evaluation_method
Information about the order in which events are evaluated and how actions are executed.
- key
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.
- role_arn
The ARN of the role that grants permission to AWS IoT Events to perform its operations.