Class CfnDetectorModel
The AWS::IoTEvents::DetectorModel resource creates a detector model.
Inherited Members
Namespace: Amazon.CDK.AWS.IoTEvents
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDetectorModel : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnDetectorModel
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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 .
When you successfully update a detector model (using the AWS IoT Events console, AWS IoT Events API or CLI commands, or AWS 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 AWS 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 AWS 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 AWS 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.
CloudformationResource: AWS::IoTEvents::DetectorModel
ExampleMetadata: fixture=_generated
Synopsis
Constructors
CfnDetectorModel(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDetectorModel(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDetectorModel(Construct, String, ICfnDetectorModelProps) |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DetectorModelDefinition | Information that defines how a detector operates. |
DetectorModelDescription | A brief description of the detector model. |
DetectorModelName | The name of the detector model. |
EvaluationMethod | Information about the order in which events are evaluated and how actions are executed. |
Key | The value used to identify a detector instance. |
RoleArn | The ARN of the role that grants permission to AWS IoT Events to perform its operations. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDetectorModel(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDetectorModel(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDetectorModel(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDetectorModel(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDetectorModel(Construct, String, ICfnDetectorModelProps)
public CfnDetectorModel(Construct scope, string id, ICfnDetectorModelProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDetectorModelProps
Resource properties.
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DetectorModelDefinition
Information that defines how a detector operates.
public virtual object DetectorModelDefinition { get; set; }
Property Value
System.Object
DetectorModelDescription
A brief description of the detector model.
public virtual string DetectorModelDescription { get; set; }
Property Value
System.String
DetectorModelName
The name of the detector model.
public virtual string DetectorModelName { get; set; }
Property Value
System.String
EvaluationMethod
Information about the order in which events are evaluated and how actions are executed.
public virtual string EvaluationMethod { get; set; }
Property Value
System.String
Key
The value used to identify a detector instance.
public virtual string Key { get; set; }
Property Value
System.String
RoleArn
The ARN of the role that grants permission to AWS IoT Events to perform its operations.
public virtual string RoleArn { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>