CfnDetectorModelPropsMixin
- class aws_cdk.mixins_preview.aws_iotevents.mixins.CfnDetectorModelPropsMixin(props, *, strategy=None)
Bases:
MixinThe AWS::IoTEvents::DetectorModel resource creates a detector model.
You create a detector model (a model of your equipment or process) using states . For each state, you define conditional (Boolean) logic that evaluates the incoming inputs to detect significant events. When an event is detected, it can change the state or trigger custom-built or predefined actions using other AWS services. You can define additional events that trigger actions when entering or exiting a state and, optionally, when a condition is met. For more information, see How to Use AWS IoT Events in the AWS IoT Events Developer Guide . .. epigraph:
When you successfully update a detector model (using the AWS IoT Events console, AWS IoT Events API or CLI commands, or CloudFormation ) all detector instances created by the model are reset to their initial states. (The detector's ``state`` , and the values of any variables and timers are reset.) When you successfully update a detector model (using the AWS IoT Events console, AWS IoT Events API or CLI commands, or CloudFormation ) the version number of the detector model is incremented. (A detector model with version number 1 before the update has version number 2 after the update succeeds.) If you attempt to update a detector model using CloudFormation and the update does not succeed, the system may, in some cases, restore the original detector model. When this occurs, the detector model's version is incremented twice (for example, from version 1 to version 3) and the detector instances are reset. Also, be aware that if you attempt to update several detector models at once using CloudFormation , some updates may succeed and others fail. In this case, the effects on each detector model's detector instances and version number depend on whether the update succeeded or failed, with the results as stated.
- See:
- CloudformationResource:
AWS::IoTEvents::DetectorModel
- Mixin:
true
- 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 import mixins from aws_cdk.mixins_preview.aws_iotevents import mixins as iotevents_mixins cfn_detector_model_props_mixin = iotevents_mixins.CfnDetectorModelPropsMixin(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" )] ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::IoTEvents::DetectorModel.- Parameters:
props (
Union[CfnDetectorModelMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['detectorModelDefinition', 'detectorModelDescription', 'detectorModelName', 'evaluationMethod', 'key', 'roleArn', 'tags']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
ActionProperty
- class CfnDetectorModelPropsMixin.ActionProperty(*, clear_timer=None, dynamo_db=None, dynamo_d_bv2=None, firehose=None, iot_events=None, iot_site_wise=None, iot_topic_publish=None, lambda_=None, reset_timer=None, set_timer=None, set_variable=None, sns=None, sqs=None)
Bases:
objectAn action to be performed when the
conditionis TRUE.- Parameters:
clear_timer (
Union[IResolvable,ClearTimerProperty,Dict[str,Any],None]) – Information needed to clear the timer.dynamo_db (
Union[IResolvable,DynamoDBProperty,Dict[str,Any],None]) – Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the payload . One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide .dynamo_d_bv2 (
Union[IResolvable,DynamoDBv2Property,Dict[str,Any],None]) –Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the payload . A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide .
firehose (
Union[IResolvable,FirehoseProperty,Dict[str,Any],None]) – Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.iot_events (
Union[IResolvable,IotEventsProperty,Dict[str,Any],None]) – Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action.iot_site_wise (
Union[IResolvable,IotSiteWiseProperty,Dict[str,Any],None]) – Sends information about the detector model instance and the event that triggered the action to an asset property in AWS IoT SiteWise .iot_topic_publish (
Union[IResolvable,IotTopicPublishProperty,Dict[str,Any],None]) – Publishes an MQTT message with the given topic to the AWS IoT message broker.lambda – Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
reset_timer (
Union[IResolvable,ResetTimerProperty,Dict[str,Any],None]) – Information needed to reset the timer.set_timer (
Union[IResolvable,SetTimerProperty,Dict[str,Any],None]) – Information needed to set the timer.set_variable (
Union[IResolvable,SetVariableProperty,Dict[str,Any],None]) – Sets a variable to a specified value.sns (
Union[IResolvable,SnsProperty,Dict[str,Any],None]) – Sends an Amazon SNS message.sqs (
Union[IResolvable,SqsProperty,Dict[str,Any],None]) – Sends an Amazon SNS message.
- See:
- 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 action_property = 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 ) )
Attributes
- clear_timer
Information needed to clear the timer.
- dynamo_d_bv2
Writes to the DynamoDB table that you created.
The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the payload . A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide .
- dynamo_db
Writes to the DynamoDB table that you created.
The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the payload . One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide .
- firehose
Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
- iot_events
Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action.
- iot_site_wise
Sends information about the detector model instance and the event that triggered the action to an asset property in AWS IoT SiteWise .
- iot_topic_publish
Publishes an MQTT message with the given topic to the AWS IoT message broker.
- lambda_
Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
- reset_timer
Information needed to reset the timer.
- set_timer
Information needed to set the timer.
- set_variable
Sets a variable to a specified value.
- sns
Sends an Amazon SNS message.
- sqs
Sends an Amazon SNS message.
AssetPropertyTimestampProperty
- class CfnDetectorModelPropsMixin.AssetPropertyTimestampProperty(*, offset_in_nanos=None, time_in_seconds=None)
Bases:
objectA structure that contains timestamp information. For more information, see TimeInNanos in the AWS IoT SiteWise API Reference .
You must use expressions for all parameters in
AssetPropertyTimestamp. The expressions accept literals, operators, functions, references, and substitution templates.Examples - For literal values, the expressions must contain single quotes. For example, the value for the
timeInSecondsparameter can be'1586400675'.For references, you must specify either variables or input values. For example, the value for the
offsetInNanosparameter can be$variable.time.For a substitution template, you must use
${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the
timeInSecondsparameter uses a substitution template.'${$input.TemperatureInput.sensorData.timestamp / 1000}'For more information, see Expressions in the AWS IoT Events Developer Guide .
- Parameters:
offset_in_nanos (
Optional[str]) – The nanosecond offset converted fromtimeInSeconds. The valid range is between 0-999999999.time_in_seconds (
Optional[str]) – The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199.
- See:
- 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 asset_property_timestamp_property = iotevents_mixins.CfnDetectorModelPropsMixin.AssetPropertyTimestampProperty( offset_in_nanos="offsetInNanos", time_in_seconds="timeInSeconds" )
Attributes
- offset_in_nanos
The nanosecond offset converted from
timeInSeconds.The valid range is between 0-999999999.
- time_in_seconds
The timestamp, in seconds, in the Unix epoch format.
The valid range is between 1-31556889864403199.
AssetPropertyValueProperty
- class CfnDetectorModelPropsMixin.AssetPropertyValueProperty(*, quality=None, timestamp=None, value=None)
Bases:
objectA structure that contains value information. For more information, see AssetPropertyValue in the AWS IoT SiteWise API Reference .
You must use expressions for all parameters in
AssetPropertyValue. The expressions accept literals, operators, functions, references, and substitution templates.Examples - For literal values, the expressions must contain single quotes. For example, the value for the
qualityparameter can be'GOOD'.For references, you must specify either variables or input values. For example, the value for the
qualityparameter can be$input.TemperatureInput.sensorData.quality.
For more information, see Expressions in the AWS IoT Events Developer Guide .
- Parameters:
quality (
Optional[str]) – The quality of the asset property value. The value must be'GOOD','BAD', or'UNCERTAIN'.timestamp (
Union[IResolvable,AssetPropertyTimestampProperty,Dict[str,Any],None]) – The timestamp associated with the asset property value. The default is the current event time.value (
Union[IResolvable,AssetPropertyVariantProperty,Dict[str,Any],None]) – The value to send to an asset property.
- See:
- 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 asset_property_value_property = 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" ) )
Attributes
- quality
The quality of the asset property value.
The value must be
'GOOD','BAD', or'UNCERTAIN'.
- timestamp
The timestamp associated with the asset property value.
The default is the current event time.
- value
The value to send to an asset property.
AssetPropertyVariantProperty
- class CfnDetectorModelPropsMixin.AssetPropertyVariantProperty(*, boolean_value=None, double_value=None, integer_value=None, string_value=None)
Bases:
objectA structure that contains an asset property value.
For more information, see Variant in the AWS IoT SiteWise API Reference .
You must use expressions for all parameters in
AssetPropertyVariant. The expressions accept literals, operators, functions, references, and substitution templates.Examples - For literal values, the expressions must contain single quotes. For example, the value for the
integerValueparameter can be'100'.For references, you must specify either variables or parameters. For example, the value for the
booleanValueparameter can be$variable.offline.For a substitution template, you must use
${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the
doubleValueparameter uses a substitution template.'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'For more information, see Expressions in the AWS IoT Events Developer Guide .
You must specify one of the following value types, depending on the
dataTypeof the specified asset property. For more information, see AssetProperty in the AWS IoT SiteWise API Reference .- Parameters:
boolean_value (
Optional[str]) – The asset property value is a Boolean value that must be'TRUE'or'FALSE'. You must use an expression, and the evaluated result should be a Boolean value.double_value (
Optional[str]) – The asset property value is a double. You must use an expression, and the evaluated result should be a double.integer_value (
Optional[str]) – The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.string_value (
Optional[str]) – The asset property value is a string. You must use an expression, and the evaluated result should be a string.
- See:
- 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 asset_property_variant_property = iotevents_mixins.CfnDetectorModelPropsMixin.AssetPropertyVariantProperty( boolean_value="booleanValue", double_value="doubleValue", integer_value="integerValue", string_value="stringValue" )
Attributes
- boolean_value
The asset property value is a Boolean value that must be
'TRUE'or'FALSE'.You must use an expression, and the evaluated result should be a Boolean value.
- double_value
The asset property value is a double.
You must use an expression, and the evaluated result should be a double.
- integer_value
The asset property value is an integer.
You must use an expression, and the evaluated result should be an integer.
- string_value
The asset property value is a string.
You must use an expression, and the evaluated result should be a string.
ClearTimerProperty
- class CfnDetectorModelPropsMixin.ClearTimerProperty(*, timer_name=None)
Bases:
objectInformation needed to clear the timer.
- Parameters:
timer_name (
Optional[str]) – The name of the timer to clear.- See:
- 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 clear_timer_property = iotevents_mixins.CfnDetectorModelPropsMixin.ClearTimerProperty( timer_name="timerName" )
Attributes
- timer_name
The name of the timer to clear.
DetectorModelDefinitionProperty
- class CfnDetectorModelPropsMixin.DetectorModelDefinitionProperty(*, initial_state_name=None, states=None)
Bases:
objectInformation that defines how a detector operates.
- Parameters:
initial_state_name (
Optional[str]) – The state that is entered at the creation of each detector (instance).states (
Union[IResolvable,Sequence[Union[IResolvable,StateProperty,Dict[str,Any]]],None]) – Information about the states of the detector.
- See:
- 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 detector_model_definition_property = 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" )] )
Attributes
- initial_state_name
The state that is entered at the creation of each detector (instance).
- states
Information about the states of the detector.
DynamoDBProperty
- class CfnDetectorModelPropsMixin.DynamoDBProperty(*, hash_key_field=None, hash_key_type=None, hash_key_value=None, operation=None, payload=None, payload_field=None, range_key_field=None, range_key_type=None, range_key_value=None, table_name=None)
Bases:
objectDefines an action to write to the Amazon DynamoDB table that you created.
The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload . One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.
You must use expressions for all parameters in
DynamoDBAction. The expressions accept literals, operators, functions, references, and substitution templates.Examples - For literal values, the expressions must contain single quotes. For example, the value for the
hashKeyTypeparameter can be'STRING'.For references, you must specify either variables or input values. For example, the value for the
hashKeyFieldparameter can be$input.GreenhouseInput.name.For a substitution template, you must use
${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the
hashKeyValueparameter uses a substitution template.'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'For a string concatenation, you must use
+. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the
tableNameparameter uses a string concatenation.'GreenhouseTemperatureTable ' + $input.GreenhouseInput.dateFor more information, see Expressions in the AWS IoT Events Developer Guide .
If the defined payload type is a string,
DynamoDBActionwrites non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for thepayloadFieldparameter is<payload-field>_raw.- Parameters:
hash_key_field (
Optional[str]) – The name of the hash key (also called the partition key). ThehashKeyFieldvalue must match the partition key of the target DynamoDB table.hash_key_type (
Optional[str]) – The data type for the hash key (also called the partition key). You can specify the following values:. -'STRING'- The hash key is a string. -'NUMBER'- The hash key is a number. If you don’t specifyhashKeyType, the default value is'STRING'.hash_key_value (
Optional[str]) – The value of the hash key (also called the partition key).operation (
Optional[str]) – The type of operation to perform. You can specify the following values:. -'INSERT'- Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key. -'UPDATE'- Update an existing item of the DynamoDB table with new data. This item’s partition key must match the specified hash key. If you specified a range key, the range key must match the item’s sort key. -'DELETE'- Delete an existing item of the DynamoDB table. This item’s partition key must match the specified hash key. If you specified a range key, the range key must match the item’s sort key. If you don’t specify this parameter, AWS IoT Events triggers the'INSERT'operation.payload (
Union[IResolvable,PayloadProperty,Dict[str,Any],None]) – Information needed to configure the payload. By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can usecontentExpression.payload_field (
Optional[str]) – The name of the DynamoDB column that receives the action payload. If you don’t specify this parameter, the name of the DynamoDB column ispayload.range_key_field (
Optional[str]) – The name of the range key (also called the sort key). TherangeKeyFieldvalue must match the sort key of the target DynamoDB table.range_key_type (
Optional[str]) – The data type for the range key (also called the sort key), You can specify the following values:. -'STRING'- The range key is a string. -'NUMBER'- The range key is number. If you don’t specifyrangeKeyField, the default value is'STRING'.range_key_value (
Optional[str]) – The value of the range key (also called the sort key).table_name (
Optional[str]) – The name of the DynamoDB table. ThetableNamevalue must match the table name of the target DynamoDB table.
- See:
- 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 dynamo_dBProperty = 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" )
Attributes
- hash_key_field
The name of the hash key (also called the partition key).
The
hashKeyFieldvalue must match the partition key of the target DynamoDB table.
- hash_key_type
.
'STRING'- The hash key is a string.'NUMBER'- The hash key is a number.
If you don’t specify
hashKeyType, the default value is'STRING'.- See:
- Type:
The data type for the hash key (also called the partition key). You can specify the following values
- hash_key_value
The value of the hash key (also called the partition key).
- operation
.
'INSERT'- Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.'UPDATE'- Update an existing item of the DynamoDB table with new data. This item’s partition key must match the specified hash key. If you specified a range key, the range key must match the item’s sort key.'DELETE'- Delete an existing item of the DynamoDB table. This item’s partition key must match the specified hash key. If you specified a range key, the range key must match the item’s sort key.
If you don’t specify this parameter, AWS IoT Events triggers the
'INSERT'operation.- See:
- Type:
The type of operation to perform. You can specify the following values
- payload
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use
contentExpression.
- payload_field
The name of the DynamoDB column that receives the action payload.
If you don’t specify this parameter, the name of the DynamoDB column is
payload.
- range_key_field
The name of the range key (also called the sort key).
The
rangeKeyFieldvalue must match the sort key of the target DynamoDB table.
- range_key_type
.
'STRING'- The range key is a string.'NUMBER'- The range key is number.
If you don’t specify
rangeKeyField, the default value is'STRING'.- See:
- Type:
The data type for the range key (also called the sort key), You can specify the following values
- range_key_value
The value of the range key (also called the sort key).
- table_name
The name of the DynamoDB table.
The
tableNamevalue must match the table name of the target DynamoDB table.
DynamoDBv2Property
- class CfnDetectorModelPropsMixin.DynamoDBv2Property(*, payload=None, table_name=None)
Bases:
objectDefines an action to write to the Amazon DynamoDB table that you created.
The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload . A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.
You must use expressions for all parameters in
DynamoDBv2Action. The expressions accept literals, operators, functions, references, and substitution templates.Examples - For literal values, the expressions must contain single quotes. For example, the value for the
tableNameparameter can be'GreenhouseTemperatureTable'.For references, you must specify either variables or input values. For example, the value for the
tableNameparameter can be$variable.ddbtableName.For a substitution template, you must use
${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the
contentExpressionparameter inPayloaduses a substitution template.'{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'For a string concatenation, you must use
+. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the
tableNameparameter uses a string concatenation.'GreenhouseTemperatureTable ' + $input.GreenhouseInput.dateFor more information, see Expressions in the AWS IoT Events Developer Guide .
The value for the
typeparameter inPayloadmust beJSON.- Parameters:
payload (
Union[IResolvable,PayloadProperty,Dict[str,Any],None]) – Information needed to configure the payload. By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can usecontentExpression.table_name (
Optional[str]) – The name of the DynamoDB table.
- See:
- 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 dynamo_dBv2_property = iotevents_mixins.CfnDetectorModelPropsMixin.DynamoDBv2Property( payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty( content_expression="contentExpression", type="type" ), table_name="tableName" )
Attributes
- payload
Information needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use
contentExpression.
- table_name
The name of the DynamoDB table.
EventProperty
- class CfnDetectorModelPropsMixin.EventProperty(*, actions=None, condition=None, event_name=None)
Bases:
objectSpecifies the
actionsto be performed when theconditionevaluates to TRUE.- Parameters:
actions (
Union[IResolvable,Sequence[Union[IResolvable,ActionProperty,Dict[str,Any]]],None]) – The actions to be performed.condition (
Optional[str]) – Optional. The Boolean expression that, when TRUE, causes theactionsto be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE).event_name (
Optional[str]) – The name of the event.
- See:
- 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 event_property = 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" )
Attributes
- actions
The actions to be performed.
- condition
Optional.
The Boolean expression that, when TRUE, causes the
actionsto be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE).
- event_name
The name of the event.
FirehoseProperty
- class CfnDetectorModelPropsMixin.FirehoseProperty(*, delivery_stream_name=None, payload=None, separator=None)
Bases:
objectSends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
- Parameters:
delivery_stream_name (
Optional[str]) – The name of the Kinesis Data Firehose delivery stream where the data is written.payload (
Union[IResolvable,PayloadProperty,Dict[str,Any],None]) – You can configure the action payload when you send a message to an Amazon Data Firehose delivery stream.separator (
Optional[str]) – A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: ‘n’ (newline), ‘t’ (tab), ‘rn’ (Windows newline), ‘,’ (comma).
- See:
- 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 firehose_property = iotevents_mixins.CfnDetectorModelPropsMixin.FirehoseProperty( delivery_stream_name="deliveryStreamName", payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty( content_expression="contentExpression", type="type" ), separator="separator" )
Attributes
- delivery_stream_name
The name of the Kinesis Data Firehose delivery stream where the data is written.
- payload
You can configure the action payload when you send a message to an Amazon Data Firehose delivery stream.
- separator
A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream.
Valid values are: ‘n’ (newline), ‘t’ (tab), ‘rn’ (Windows newline), ‘,’ (comma).
IotEventsProperty
- class CfnDetectorModelPropsMixin.IotEventsProperty(*, input_name=None, payload=None)
Bases:
objectSends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
- Parameters:
input_name (
Optional[str]) – The name of the AWS IoT Events input where the data is sent.payload (
Union[IResolvable,PayloadProperty,Dict[str,Any],None]) – You can configure the action payload when you send a message to an AWS IoT Events input.
- See:
- 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 iot_events_property = iotevents_mixins.CfnDetectorModelPropsMixin.IotEventsProperty( input_name="inputName", payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty( content_expression="contentExpression", type="type" ) )
Attributes
- input_name
The name of the AWS IoT Events input where the data is sent.
- payload
You can configure the action payload when you send a message to an AWS IoT Events input.
IotSiteWiseProperty
- class CfnDetectorModelPropsMixin.IotSiteWiseProperty(*, asset_id=None, entry_id=None, property_alias=None, property_id=None, property_value=None)
Bases:
objectSends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise .
You must use expressions for all parameters in
IotSiteWiseAction. The expressions accept literals, operators, functions, references, and substitutions templates.Examples - For literal values, the expressions must contain single quotes. For example, the value for the
propertyAliasparameter can be'/company/windfarm/3/turbine/7/temperature'.For references, you must specify either variables or input values. For example, the value for the
assetIdparameter can be$input.TurbineInput.assetId1.For a substitution template, you must use
${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.
In the following example, the value for the
propertyAliasparameter uses a substitution template.'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'You must specify either
propertyAliasor bothassetIdandpropertyIdto identify the target asset property in AWS IoT SiteWise .For more information, see Expressions in the AWS IoT Events Developer Guide .
- Parameters:
asset_id (
Optional[str]) – The ID of the asset that has the specified property.entry_id (
Optional[str]) – A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.property_alias (
Optional[str]) – The alias of the asset property.property_id (
Optional[str]) – The ID of the asset property.property_value (
Union[IResolvable,AssetPropertyValueProperty,Dict[str,Any],None]) – The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
- See:
- 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 iot_site_wise_property = 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" ) ) )
Attributes
- asset_id
The ID of the asset that has the specified property.
- entry_id
A unique identifier for this entry.
You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.
- property_alias
The alias of the asset property.
- property_id
The ID of the asset property.
- property_value
The value to send to the asset property.
This value contains timestamp, quality, and value (TQV) information.
IotTopicPublishProperty
- class CfnDetectorModelPropsMixin.IotTopicPublishProperty(*, mqtt_topic=None, payload=None)
Bases:
objectInformation required to publish the MQTT message through the AWS IoT message broker.
- Parameters:
mqtt_topic (
Optional[str]) – The MQTT topic of the message. You can use a string expression that includes variables ($variable.<variable-name>) and input values ($input.<input-name>.<path-to-datum>) as the topic string.payload (
Union[IResolvable,PayloadProperty,Dict[str,Any],None]) – You can configure the action payload when you publish a message to an AWS IoT Core topic.
- See:
- 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 iot_topic_publish_property = iotevents_mixins.CfnDetectorModelPropsMixin.IotTopicPublishProperty( mqtt_topic="mqttTopic", payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty( content_expression="contentExpression", type="type" ) )
Attributes
- mqtt_topic
The MQTT topic of the message.
You can use a string expression that includes variables (
$variable.<variable-name>) and input values ($input.<input-name>.<path-to-datum>) as the topic string.
- payload
You can configure the action payload when you publish a message to an AWS IoT Core topic.
LambdaProperty
- class CfnDetectorModelPropsMixin.LambdaProperty(*, function_arn=None, payload=None)
Bases:
objectCalls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
- Parameters:
function_arn (
Optional[str]) – The ARN of the Lambda function that is executed.payload (
Union[IResolvable,PayloadProperty,Dict[str,Any],None]) – You can configure the action payload when you send a message to a Lambda function.
- See:
- 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 lambda_property = iotevents_mixins.CfnDetectorModelPropsMixin.LambdaProperty( function_arn="functionArn", payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty( content_expression="contentExpression", type="type" ) )
Attributes
- function_arn
The ARN of the Lambda function that is executed.
- payload
You can configure the action payload when you send a message to a Lambda function.
OnEnterProperty
- class CfnDetectorModelPropsMixin.OnEnterProperty(*, events=None)
Bases:
objectWhen entering this state, perform these
actionsif theconditionis TRUE.- Parameters:
events (
Union[IResolvable,Sequence[Union[IResolvable,EventProperty,Dict[str,Any]]],None]) – Specifies the actions that are performed when the state is entered and theconditionisTRUE.- See:
- 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 on_enter_property = 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" )] )
Attributes
- events
Specifies the actions that are performed when the state is entered and the
conditionisTRUE.
OnExitProperty
- class CfnDetectorModelPropsMixin.OnExitProperty(*, events=None)
Bases:
objectWhen exiting this state, perform these
actionsif the specifiedconditionisTRUE.- Parameters:
events (
Union[IResolvable,Sequence[Union[IResolvable,EventProperty,Dict[str,Any]]],None]) – Specifies theactionsthat are performed when the state is exited and theconditionisTRUE.- See:
- 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 on_exit_property = 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" )] )
Attributes
- events
Specifies the
actionsthat are performed when the state is exited and theconditionisTRUE.
OnInputProperty
- class CfnDetectorModelPropsMixin.OnInputProperty(*, events=None, transition_events=None)
Bases:
objectSpecifies the actions performed when the
conditionevaluates to TRUE.- Parameters:
events (
Union[IResolvable,Sequence[Union[IResolvable,EventProperty,Dict[str,Any]]],None]) – Specifies the actions performed when theconditionevaluates to TRUE.transition_events (
Union[IResolvable,Sequence[Union[IResolvable,TransitionEventProperty,Dict[str,Any]]],None]) – Specifies the actions performed, and the next state entered, when aconditionevaluates to TRUE.
- See:
- 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 on_input_property = 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" )] )
Attributes
- events
Specifies the actions performed when the
conditionevaluates to TRUE.
- transition_events
Specifies the actions performed, and the next state entered, when a
conditionevaluates to TRUE.
PayloadProperty
- class CfnDetectorModelPropsMixin.PayloadProperty(*, content_expression=None, type=None)
Bases:
objectInformation needed to configure the payload.
By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use
contentExpression.- Parameters:
content_expression (
Optional[str]) – The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain${}as the content. The recommended maximum size of a content expression is 1 KB.type (
Optional[str]) – The value of the payload type can be eitherSTRINGorJSON.
- See:
- 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 payload_property = iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty( content_expression="contentExpression", type="type" )
Attributes
- content_expression
The content of the payload.
You can use a string expression that includes quoted strings (
'<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain${}as the content. The recommended maximum size of a content expression is 1 KB.
- type
The value of the payload type can be either
STRINGorJSON.
ResetTimerProperty
- class CfnDetectorModelPropsMixin.ResetTimerProperty(*, timer_name=None)
Bases:
objectInformation required to reset the timer.
The timer is reset to the previously evaluated result of the duration. The duration expression isn’t reevaluated when you reset the timer.
- Parameters:
timer_name (
Optional[str]) – The name of the timer to reset.- See:
- 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 reset_timer_property = iotevents_mixins.CfnDetectorModelPropsMixin.ResetTimerProperty( timer_name="timerName" )
Attributes
- timer_name
The name of the timer to reset.
SetTimerProperty
- class CfnDetectorModelPropsMixin.SetTimerProperty(*, duration_expression=None, seconds=None, timer_name=None)
Bases:
objectInformation needed to set the timer.
- Parameters:
duration_expression (
Optional[str]) – The duration of the timer, in seconds. You can use a string expression that includes numbers, variables ($variable.<variable-name>), and input values ($input.<input-name>.<path-to-datum>) as the duration. The range of the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds. The evaluated result of the duration is rounded down to the nearest whole number.seconds (
Union[int,float,None]) – The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds.timer_name (
Optional[str]) – The name of the timer.
- See:
- 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 set_timer_property = iotevents_mixins.CfnDetectorModelPropsMixin.SetTimerProperty( duration_expression="durationExpression", seconds=123, timer_name="timerName" )
Attributes
- duration_expression
The duration of the timer, in seconds.
You can use a string expression that includes numbers, variables (
$variable.<variable-name>), and input values ($input.<input-name>.<path-to-datum>) as the duration. The range of the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds. The evaluated result of the duration is rounded down to the nearest whole number.
- seconds
The number of seconds until the timer expires.
The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds.
SetVariableProperty
- class CfnDetectorModelPropsMixin.SetVariableProperty(*, value=None, variable_name=None)
Bases:
objectInformation about the variable and its new value.
- Parameters:
value (
Optional[str]) – The new value of the variable.variable_name (
Optional[str]) – The name of the variable.
- See:
- 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 set_variable_property = iotevents_mixins.CfnDetectorModelPropsMixin.SetVariableProperty( value="value", variable_name="variableName" )
Attributes
- value
The new value of the variable.
- variable_name
The name of the variable.
SnsProperty
- class CfnDetectorModelPropsMixin.SnsProperty(*, payload=None, target_arn=None)
Bases:
objectInformation required to publish the Amazon SNS message.
- Parameters:
payload (
Union[IResolvable,PayloadProperty,Dict[str,Any],None]) – You can configure the action payload when you send a message as an Amazon SNS push notification.target_arn (
Optional[str]) – The ARN of the Amazon SNS target where the message is sent.
- See:
- 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 sns_property = iotevents_mixins.CfnDetectorModelPropsMixin.SnsProperty( payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty( content_expression="contentExpression", type="type" ), target_arn="targetArn" )
Attributes
- payload
You can configure the action payload when you send a message as an Amazon SNS push notification.
- target_arn
The ARN of the Amazon SNS target where the message is sent.
SqsProperty
- class CfnDetectorModelPropsMixin.SqsProperty(*, payload=None, queue_url=None, use_base64=None)
Bases:
objectSends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
- Parameters:
payload (
Union[IResolvable,PayloadProperty,Dict[str,Any],None]) – You can configure the action payload when you send a message to an Amazon SQS queue.queue_url (
Optional[str]) – The URL of the SQS queue where the data is written.use_base64 (
Union[bool,IResolvable,None]) – Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to FALSE.
- See:
- 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 sqs_property = iotevents_mixins.CfnDetectorModelPropsMixin.SqsProperty( payload=iotevents_mixins.CfnDetectorModelPropsMixin.PayloadProperty( content_expression="contentExpression", type="type" ), queue_url="queueUrl", use_base64=False )
Attributes
- payload
You can configure the action payload when you send a message to an Amazon SQS queue.
- queue_url
The URL of the SQS queue where the data is written.
- use_base64
Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue.
Otherwise, set this to FALSE.
StateProperty
- class CfnDetectorModelPropsMixin.StateProperty(*, on_enter=None, on_exit=None, on_input=None, state_name=None)
Bases:
objectInformation that defines a state of a detector.
- Parameters:
on_enter (
Union[IResolvable,OnEnterProperty,Dict[str,Any],None]) – When entering this state, perform theseactionsif theconditionis TRUE.on_exit (
Union[IResolvable,OnExitProperty,Dict[str,Any],None]) – When exiting this state, perform theseactionsif the specifiedconditionisTRUE.on_input (
Union[IResolvable,OnInputProperty,Dict[str,Any],None]) – When an input is received and theconditionis TRUE, perform the specifiedactions.state_name (
Optional[str]) – The name of the state.
- See:
- 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 state_property = 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" )
Attributes
- on_enter
When entering this state, perform these
actionsif theconditionis TRUE.
- on_exit
When exiting this state, perform these
actionsif the specifiedconditionisTRUE.
- on_input
When an input is received and the
conditionis TRUE, perform the specifiedactions.
- state_name
The name of the state.
TransitionEventProperty
- class CfnDetectorModelPropsMixin.TransitionEventProperty(*, actions=None, condition=None, event_name=None, next_state=None)
Bases:
objectSpecifies the actions performed and the next state entered when a
conditionevaluates to TRUE.- Parameters:
actions (
Union[IResolvable,Sequence[Union[IResolvable,ActionProperty,Dict[str,Any]]],None]) – The actions to be performed.condition (
Optional[str]) – Required. A Boolean expression that when TRUE causes the actions to be performed and thenextStateto be entered.event_name (
Optional[str]) – The name of the transition event.next_state (
Optional[str]) – The next state to enter.
- See:
- 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 transition_event_property = 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" )
Attributes
- actions
The actions to be performed.
- condition
Required.
A Boolean expression that when TRUE causes the actions to be performed and the
nextStateto be entered.
- event_name
The name of the transition event.