CfnDetectorModelMixinProps

class aws_cdk.mixins_preview.aws_iotevents.mixins.CfnDetectorModelMixinProps(*, detector_model_definition=None, detector_model_description=None, detector_model_name=None, evaluation_method=None, key=None, role_arn=None, tags=None)

Bases: object

Properties for CfnDetectorModelPropsMixin.

Parameters:

detector_model_definition (Union[IResolvable, DetectorModelDefinitionProperty, Dict[str, Any], None]) – Information that defines how a detector operates.
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.
role_arn (Optional[str]) – The ARN of the role that grants permission to AWS IoT Events to perform its operations.
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:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotevents import mixins as iotevents_mixins

cfn_detector_model_mixin_props = iotevents_mixins.CfnDetectorModelMixinProps(
    detector_model_definition=iotevents_mixins.CfnDetectorModelPropsMixin.DetectorModelDefinitionProperty(
        initial_state_name="initialStateName",
        states=[iotevents_mixins.CfnDetectorModelPropsMixin.StateProperty(
            on_enter=iotevents_mixins.CfnDetectorModelPropsMixin.OnEnterProperty(
                events=[iotevents_mixins.CfnDetectorModelPropsMixin.EventProperty(
                    actions=[iotevents_mixins.CfnDetectorModelPropsMixin.ActionProperty(
                        clear_timer=iotevents_mixins.CfnDetectorModelPropsMixin.ClearTimerProperty(
                            timer_name="timerName"
                        ),
                        dynamo_db=iotevents_mixins.CfnDetectorModelPropsMixin.DynamoDBProperty(
                            hash_key_field="hashKeyField",
                            hash_key_type="hashKeyType",
                            hash_key_value="hashKeyValue",
                            operation="operation",
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            ),
                            payload_field="payloadField",
                            range_key_field="rangeKeyField",
                            range_key_type="rangeKeyType",
                            range_key_value="rangeKeyValue",
                            table_name="tableName"
                        ),
                        dynamo_dBv2=iotevents_mixins.CfnDetectorModelPropsMixin.DynamoDBv2Property(
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            ),
                            table_name="tableName"
                        ),
                        firehose=iotevents_mixins.CfnDetectorModelPropsMixin.FirehoseProperty(
                            delivery_stream_name="deliveryStreamName",
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            ),
                            separator="separator"
                        ),
                        iot_events=iotevents_mixins.CfnDetectorModelPropsMixin.IotEventsProperty(
                            input_name="inputName",
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            )
                        ),
                        iot_site_wise=iotevents_mixins.CfnDetectorModelPropsMixin.IotSiteWiseProperty(
                            asset_id="assetId",
                            entry_id="entryId",
                            property_alias="propertyAlias",
                            property_id="propertyId",
                            property_value=iotevents_mixins.CfnDetectorModelPropsMixin.AssetPropertyValueProperty(
                                quality="quality",
                                timestamp=iotevents_mixins.CfnDetectorModelPropsMixin.AssetPropertyTimestampProperty(
                                    offset_in_nanos="offsetInNanos",
                                    time_in_seconds="timeInSeconds"
                                ),
                                value=iotevents_mixins.CfnDetectorModelPropsMixin.AssetPropertyVariantProperty(
                                    boolean_value="booleanValue",
                                    double_value="doubleValue",
                                    integer_value="integerValue",
                                    string_value="stringValue"
                                )
                            )
                        ),
                        iot_topic_publish=iotevents_mixins.CfnDetectorModelPropsMixin.IotTopicPublishProperty(
                            mqtt_topic="mqttTopic",
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            )
                        ),
                        lambda_=iotevents_mixins.CfnDetectorModelPropsMixin.LambdaProperty(
                            function_arn="functionArn",
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            )
                        ),
                        reset_timer=iotevents_mixins.CfnDetectorModelPropsMixin.ResetTimerProperty(
                            timer_name="timerName"
                        ),
                        set_timer=iotevents_mixins.CfnDetectorModelPropsMixin.SetTimerProperty(
                            duration_expression="durationExpression",
                            seconds=123,
                            timer_name="timerName"
                        ),
                        set_variable=iotevents_mixins.CfnDetectorModelPropsMixin.SetVariableProperty(
                            value="value",
                            variable_name="variableName"
                        ),
                        sns=iotevents_mixins.CfnDetectorModelPropsMixin.SnsProperty(
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            ),
                            target_arn="targetArn"
                        ),
                        sqs=iotevents_mixins.CfnDetectorModelPropsMixin.SqsProperty(
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            ),
                            queue_url="queueUrl",
                            use_base64=False
                        )
                    )],
                    condition="condition",
                    event_name="eventName"
                )]
            ),
            on_exit=iotevents_mixins.CfnDetectorModelPropsMixin.OnExitProperty(
                events=[iotevents_mixins.CfnDetectorModelPropsMixin.EventProperty(
                    actions=[iotevents_mixins.CfnDetectorModelPropsMixin.ActionProperty(
                        clear_timer=iotevents_mixins.CfnDetectorModelPropsMixin.ClearTimerProperty(
                            timer_name="timerName"
                        ),
                        dynamo_db=iotevents_mixins.CfnDetectorModelPropsMixin.DynamoDBProperty(
                            hash_key_field="hashKeyField",
                            hash_key_type="hashKeyType",
                            hash_key_value="hashKeyValue",
                            operation="operation",
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            ),
                            payload_field="payloadField",
                            range_key_field="rangeKeyField",
                            range_key_type="rangeKeyType",
                            range_key_value="rangeKeyValue",
                            table_name="tableName"
                        ),
                        dynamo_dBv2=iotevents_mixins.CfnDetectorModelPropsMixin.DynamoDBv2Property(
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            ),
                            table_name="tableName"
                        ),
                        firehose=iotevents_mixins.CfnDetectorModelPropsMixin.FirehoseProperty(
                            delivery_stream_name="deliveryStreamName",
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            ),
                            separator="separator"
                        ),
                        iot_events=iotevents_mixins.CfnDetectorModelPropsMixin.IotEventsProperty(
                            input_name="inputName",
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            )
                        ),
                        iot_site_wise=iotevents_mixins.CfnDetectorModelPropsMixin.IotSiteWiseProperty(
                            asset_id="assetId",
                            entry_id="entryId",
                            property_alias="propertyAlias",
                            property_id="propertyId",
                            property_value=iotevents_mixins.CfnDetectorModelPropsMixin.AssetPropertyValueProperty(
                                quality="quality",
                                timestamp=iotevents_mixins.CfnDetectorModelPropsMixin.AssetPropertyTimestampProperty(
                                    offset_in_nanos="offsetInNanos",
                                    time_in_seconds="timeInSeconds"
                                ),
                                value=iotevents_mixins.CfnDetectorModelPropsMixin.AssetPropertyVariantProperty(
                                    boolean_value="booleanValue",
                                    double_value="doubleValue",
                                    integer_value="integerValue",
                                    string_value="stringValue"
                                )
                            )
                        ),
                        iot_topic_publish=iotevents_mixins.CfnDetectorModelPropsMixin.IotTopicPublishProperty(
                            mqtt_topic="mqttTopic",
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            )
                        ),
                        lambda_=iotevents_mixins.CfnDetectorModelPropsMixin.LambdaProperty(
                            function_arn="functionArn",
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            )
                        ),
                        reset_timer=iotevents_mixins.CfnDetectorModelPropsMixin.ResetTimerProperty(
                            timer_name="timerName"
                        ),
                        set_timer=iotevents_mixins.CfnDetectorModelPropsMixin.SetTimerProperty(
                            duration_expression="durationExpression",
                            seconds=123,
                            timer_name="timerName"
                        ),
                        set_variable=iotevents_mixins.CfnDetectorModelPropsMixin.SetVariableProperty(
                            value="value",
                            variable_name="variableName"
                        ),
                        sns=iotevents_mixins.CfnDetectorModelPropsMixin.SnsProperty(
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            ),
                            target_arn="targetArn"
                        ),
                        sqs=iotevents_mixins.CfnDetectorModelPropsMixin.SqsProperty(
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            ),
                            queue_url="queueUrl",
                            use_base64=False
                        )
                    )],
                    condition="condition",
                    event_name="eventName"
                )]
            ),
            on_input=iotevents_mixins.CfnDetectorModelPropsMixin.OnInputProperty(
                events=[iotevents_mixins.CfnDetectorModelPropsMixin.EventProperty(
                    actions=[iotevents_mixins.CfnDetectorModelPropsMixin.ActionProperty(
                        clear_timer=iotevents_mixins.CfnDetectorModelPropsMixin.ClearTimerProperty(
                            timer_name="timerName"
                        ),
                        dynamo_db=iotevents_mixins.CfnDetectorModelPropsMixin.DynamoDBProperty(
                            hash_key_field="hashKeyField",
                            hash_key_type="hashKeyType",
                            hash_key_value="hashKeyValue",
                            operation="operation",
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            ),
                            payload_field="payloadField",
                            range_key_field="rangeKeyField",
                            range_key_type="rangeKeyType",
                            range_key_value="rangeKeyValue",
                            table_name="tableName"
                        ),
                        dynamo_dBv2=iotevents_mixins.CfnDetectorModelPropsMixin.DynamoDBv2Property(
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            ),
                            table_name="tableName"
                        ),
                        firehose=iotevents_mixins.CfnDetectorModelPropsMixin.FirehoseProperty(
                            delivery_stream_name="deliveryStreamName",
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            ),
                            separator="separator"
                        ),
                        iot_events=iotevents_mixins.CfnDetectorModelPropsMixin.IotEventsProperty(
                            input_name="inputName",
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            )
                        ),
                        iot_site_wise=iotevents_mixins.CfnDetectorModelPropsMixin.IotSiteWiseProperty(
                            asset_id="assetId",
                            entry_id="entryId",
                            property_alias="propertyAlias",
                            property_id="propertyId",
                            property_value=iotevents_mixins.CfnDetectorModelPropsMixin.AssetPropertyValueProperty(
                                quality="quality",
                                timestamp=iotevents_mixins.CfnDetectorModelPropsMixin.AssetPropertyTimestampProperty(
                                    offset_in_nanos="offsetInNanos",
                                    time_in_seconds="timeInSeconds"
                                ),
                                value=iotevents_mixins.CfnDetectorModelPropsMixin.AssetPropertyVariantProperty(
                                    boolean_value="booleanValue",
                                    double_value="doubleValue",
                                    integer_value="integerValue",
                                    string_value="stringValue"
                                )
                            )
                        ),
                        iot_topic_publish=iotevents_mixins.CfnDetectorModelPropsMixin.IotTopicPublishProperty(
                            mqtt_topic="mqttTopic",
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            )
                        ),
                        lambda_=iotevents_mixins.CfnDetectorModelPropsMixin.LambdaProperty(
                            function_arn="functionArn",
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            )
                        ),
                        reset_timer=iotevents_mixins.CfnDetectorModelPropsMixin.ResetTimerProperty(
                            timer_name="timerName"
                        ),
                        set_timer=iotevents_mixins.CfnDetectorModelPropsMixin.SetTimerProperty(
                            duration_expression="durationExpression",
                            seconds=123,
                            timer_name="timerName"
                        ),
                        set_variable=iotevents_mixins.CfnDetectorModelPropsMixin.SetVariableProperty(
                            value="value",
                            variable_name="variableName"
                        ),
                        sns=iotevents_mixins.CfnDetectorModelPropsMixin.SnsProperty(
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            ),
                            target_arn="targetArn"
                        ),
                        sqs=iotevents_mixins.CfnDetectorModelPropsMixin.SqsProperty(
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            ),
                            queue_url="queueUrl",
                            use_base64=False
                        )
                    )],
                    condition="condition",
                    event_name="eventName"
                )],
                transition_events=[iotevents_mixins.CfnDetectorModelPropsMixin.TransitionEventProperty(
                    actions=[iotevents_mixins.CfnDetectorModelPropsMixin.ActionProperty(
                        clear_timer=iotevents_mixins.CfnDetectorModelPropsMixin.ClearTimerProperty(
                            timer_name="timerName"
                        ),
                        dynamo_db=iotevents_mixins.CfnDetectorModelPropsMixin.DynamoDBProperty(
                            hash_key_field="hashKeyField",
                            hash_key_type="hashKeyType",
                            hash_key_value="hashKeyValue",
                            operation="operation",
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            ),
                            payload_field="payloadField",
                            range_key_field="rangeKeyField",
                            range_key_type="rangeKeyType",
                            range_key_value="rangeKeyValue",
                            table_name="tableName"
                        ),
                        dynamo_dBv2=iotevents_mixins.CfnDetectorModelPropsMixin.DynamoDBv2Property(
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            ),
                            table_name="tableName"
                        ),
                        firehose=iotevents_mixins.CfnDetectorModelPropsMixin.FirehoseProperty(
                            delivery_stream_name="deliveryStreamName",
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            ),
                            separator="separator"
                        ),
                        iot_events=iotevents_mixins.CfnDetectorModelPropsMixin.IotEventsProperty(
                            input_name="inputName",
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            )
                        ),
                        iot_site_wise=iotevents_mixins.CfnDetectorModelPropsMixin.IotSiteWiseProperty(
                            asset_id="assetId",
                            entry_id="entryId",
                            property_alias="propertyAlias",
                            property_id="propertyId",
                            property_value=iotevents_mixins.CfnDetectorModelPropsMixin.AssetPropertyValueProperty(
                                quality="quality",
                                timestamp=iotevents_mixins.CfnDetectorModelPropsMixin.AssetPropertyTimestampProperty(
                                    offset_in_nanos="offsetInNanos",
                                    time_in_seconds="timeInSeconds"
                                ),
                                value=iotevents_mixins.CfnDetectorModelPropsMixin.AssetPropertyVariantProperty(
                                    boolean_value="booleanValue",
                                    double_value="doubleValue",
                                    integer_value="integerValue",
                                    string_value="stringValue"
                                )
                            )
                        ),
                        iot_topic_publish=iotevents_mixins.CfnDetectorModelPropsMixin.IotTopicPublishProperty(
                            mqtt_topic="mqttTopic",
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            )
                        ),
                        lambda_=iotevents_mixins.CfnDetectorModelPropsMixin.LambdaProperty(
                            function_arn="functionArn",
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            )
                        ),
                        reset_timer=iotevents_mixins.CfnDetectorModelPropsMixin.ResetTimerProperty(
                            timer_name="timerName"
                        ),
                        set_timer=iotevents_mixins.CfnDetectorModelPropsMixin.SetTimerProperty(
                            duration_expression="durationExpression",
                            seconds=123,
                            timer_name="timerName"
                        ),
                        set_variable=iotevents_mixins.CfnDetectorModelPropsMixin.SetVariableProperty(
                            value="value",
                            variable_name="variableName"
                        ),
                        sns=iotevents_mixins.CfnDetectorModelPropsMixin.SnsProperty(
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            ),
                            target_arn="targetArn"
                        ),
                        sqs=iotevents_mixins.CfnDetectorModelPropsMixin.SqsProperty(
                            payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty(
                                content_expression="contentExpression",
                                type="type"
                            ),
                            queue_url="queueUrl",
                            use_base64=False
                        )
                    )],
                    condition="condition",
                    event_name="eventName",
                    next_state="nextState"
                )]
            ),
            state_name="stateName"
        )]
    ),
    detector_model_description="detectorModelDescription",
    detector_model_name="detectorModelName",
    evaluation_method="evaluationMethod",
    key="key",
    role_arn="roleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

detector_model_definition

Information that defines how a detector operates.

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

detector_model_description

A brief description of the detector model.

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

detector_model_name

The name of the detector model.

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

evaluation_method

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

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

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.

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

role_arn

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

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

tags

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

For more information, see Tag .

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