Package software.amazon.awscdk.services.iotevents

Class CfnDetectorModel

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iotevents.CfnDetectorModel

All Implemented Interfaces:

IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-11T23:26:34.854Z")
@Stability(Stable)
public class CfnDetectorModel
extends CfnResource
implements IInspectable, ITaggable

The 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 .

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.

Example:

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnDetectorModel.ActionProperty	An action to be performed when the condition is TRUE.
static interface	CfnDetectorModel.AssetPropertyTimestampProperty	A structure that contains timestamp information.
static interface	CfnDetectorModel.AssetPropertyValueProperty	A structure that contains value information.
static interface	CfnDetectorModel.AssetPropertyVariantProperty	A structure that contains an asset property value.
static final class	CfnDetectorModel.Builder	A fluent builder for CfnDetectorModel.
static interface	CfnDetectorModel.ClearTimerProperty	Information needed to clear the timer.
static interface	CfnDetectorModel.DetectorModelDefinitionProperty	Information that defines how a detector operates.
static interface	CfnDetectorModel.DynamoDBProperty	Defines an action to write to the Amazon DynamoDB table that you created.
static interface	CfnDetectorModel.DynamoDBv2Property	Defines an action to write to the Amazon DynamoDB table that you created.
static interface	CfnDetectorModel.EventProperty	Specifies the actions to be performed when the condition evaluates to TRUE.
static interface	CfnDetectorModel.FirehoseProperty	Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
static interface	CfnDetectorModel.IotEventsProperty	Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
static interface	CfnDetectorModel.IotSiteWiseProperty	Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise .
static interface	CfnDetectorModel.IotTopicPublishProperty	Information required to publish the MQTT message through the AWS IoT message broker.
static interface	CfnDetectorModel.LambdaProperty	Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
static interface	CfnDetectorModel.OnEnterProperty	When entering this state, perform these actions if the condition is TRUE.
static interface	CfnDetectorModel.OnExitProperty	When exiting this state, perform these actions if the specified condition is TRUE .
static interface	CfnDetectorModel.OnInputProperty	Specifies the actions performed when the condition evaluates to TRUE.
static interface	CfnDetectorModel.PayloadProperty	Information needed to configure the payload.
static interface	CfnDetectorModel.ResetTimerProperty	Information required to reset the timer.
static interface	CfnDetectorModel.SetTimerProperty	Information needed to set the timer.
static interface	CfnDetectorModel.SetVariableProperty	Information about the variable and its new value.
static interface	CfnDetectorModel.SnsProperty	Information required to publish the Amazon SNS message.
static interface	CfnDetectorModel.SqsProperty	Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
static interface	CfnDetectorModel.StateProperty	Information that defines a state of a detector.
static interface	CfnDetectorModel.TransitionEventProperty	Specifies the actions performed and the next state entered when a condition evaluates to TRUE.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDetectorModel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDetectorModel(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDetectorModel(software.constructs.Construct scope, String id, CfnDetectorModelProps props)

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getCfnProperties()
Object	getDetectorModelDefinition()	Information that defines how a detector operates.
String	getDetectorModelDescription()	A brief description of the detector model.
String	getDetectorModelName()	The name of the detector model.
String	getEvaluationMethod()	Information about the order in which events are evaluated and how actions are executed.
String	getKey()	The value used to identify a detector instance.
String	getRoleArn()	The ARN of the role that grants permission to AWS IoT Events to perform its operations.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDetectorModelDefinition(IResolvable value)	Information that defines how a detector operates.
void	setDetectorModelDefinition(CfnDetectorModel.DetectorModelDefinitionProperty value)	Information that defines how a detector operates.
void	setDetectorModelDescription(String value)	A brief description of the detector model.
void	setDetectorModelName(String value)	The name of the detector model.
void	setEvaluationMethod(String value)	Information about the order in which events are evaluated and how actions are executed.
void	setKey(String value)	The value used to identify a detector instance.
void	setRoleArn(String value)	The ARN of the role that grants permission to AWS IoT Events to perform its operations.
void	setTagsRaw(List<CfnTag> value)	An array of key-value pairs to apply to this resource.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnDetectorModel

protected CfnDetectorModel(software.amazon.jsii.JsiiObjectRef objRef)

CfnDetectorModel

protected CfnDetectorModel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDetectorModel

@Stability(Stable)
public CfnDetectorModel(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnDetectorModelProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getDetectorModelDefinition

@Stability(Stable)
@NotNull
public Object getDetectorModelDefinition()

Information that defines how a detector operates.

setDetectorModelDefinition

@Stability(Stable)
public void setDetectorModelDefinition(@NotNull
 IResolvable value)

Information that defines how a detector operates.

setDetectorModelDefinition

@Stability(Stable)
public void setDetectorModelDefinition(@NotNull
 CfnDetectorModel.DetectorModelDefinitionProperty value)

Information that defines how a detector operates.

getRoleArn

@Stability(Stable)
@NotNull
public String getRoleArn()

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

setRoleArn

@Stability(Stable)
public void setRoleArn(@NotNull
 String value)

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

getDetectorModelDescription

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

A brief description of the detector model.

setDetectorModelDescription

@Stability(Stable)
public void setDetectorModelDescription(@Nullable
 String value)

A brief description of the detector model.

getDetectorModelName

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

The name of the detector model.

setDetectorModelName

@Stability(Stable)
public void setDetectorModelName(@Nullable
 String value)

The name of the detector model.

getEvaluationMethod

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

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

setEvaluationMethod

@Stability(Stable)
public void setEvaluationMethod(@Nullable
 String value)

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

getKey

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

The value used to identify a detector instance.

setKey

@Stability(Stable)
public void setKey(@Nullable
 String value)

The value used to identify a detector instance.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

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

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

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