1.204.0

class CfnDetectorModel (construct)

LanguageType name
.NETAmazon.CDK.AWS.IoTEvents.CfnDetectorModel
Javasoftware.amazon.awscdk.services.iotevents.CfnDetectorModel
Pythonaws_cdk.aws_iotevents.CfnDetectorModel
TypeScript @aws-cdk/aws-iotevents » CfnDetectorModel

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::IoTEvents::DetectorModel.

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

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as iotevents from '@aws-cdk/aws-iotevents';
const cfnDetectorModel = new iotevents.CfnDetectorModel(this, 'MyCfnDetectorModel', {
  detectorModelDefinition: {
    initialStateName: 'initialStateName',
    states: [{
      stateName: 'stateName',

      // the properties below are optional
      onEnter: {
        events: [{
          eventName: 'eventName',

          // the properties below are optional
          actions: [{
            clearTimer: {
              timerName: 'timerName',
            },
            dynamoDb: {
              hashKeyField: 'hashKeyField',
              hashKeyValue: 'hashKeyValue',
              tableName: 'tableName',

              // the properties below are optional
              hashKeyType: 'hashKeyType',
              operation: 'operation',
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
              payloadField: 'payloadField',
              rangeKeyField: 'rangeKeyField',
              rangeKeyType: 'rangeKeyType',
              rangeKeyValue: 'rangeKeyValue',
            },
            dynamoDBv2: {
              tableName: 'tableName',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
            },
            firehose: {
              deliveryStreamName: 'deliveryStreamName',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
              separator: 'separator',
            },
            iotEvents: {
              inputName: 'inputName',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
            },
            iotSiteWise: {
              propertyValue: {
                value: {
                  booleanValue: 'booleanValue',
                  doubleValue: 'doubleValue',
                  integerValue: 'integerValue',
                  stringValue: 'stringValue',
                },

                // the properties below are optional
                quality: 'quality',
                timestamp: {
                  timeInSeconds: 'timeInSeconds',

                  // the properties below are optional
                  offsetInNanos: 'offsetInNanos',
                },
              },

              // the properties below are optional
              assetId: 'assetId',
              entryId: 'entryId',
              propertyAlias: 'propertyAlias',
              propertyId: 'propertyId',
            },
            iotTopicPublish: {
              mqttTopic: 'mqttTopic',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
            },
            lambda: {
              functionArn: 'functionArn',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
            },
            resetTimer: {
              timerName: 'timerName',
            },
            setTimer: {
              timerName: 'timerName',

              // the properties below are optional
              durationExpression: 'durationExpression',
              seconds: 123,
            },
            setVariable: {
              value: 'value',
              variableName: 'variableName',
            },
            sns: {
              targetArn: 'targetArn',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
            },
            sqs: {
              queueUrl: 'queueUrl',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
              useBase64: false,
            },
          }],
          condition: 'condition',
        }],
      },
      onExit: {
        events: [{
          eventName: 'eventName',

          // the properties below are optional
          actions: [{
            clearTimer: {
              timerName: 'timerName',
            },
            dynamoDb: {
              hashKeyField: 'hashKeyField',
              hashKeyValue: 'hashKeyValue',
              tableName: 'tableName',

              // the properties below are optional
              hashKeyType: 'hashKeyType',
              operation: 'operation',
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
              payloadField: 'payloadField',
              rangeKeyField: 'rangeKeyField',
              rangeKeyType: 'rangeKeyType',
              rangeKeyValue: 'rangeKeyValue',
            },
            dynamoDBv2: {
              tableName: 'tableName',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
            },
            firehose: {
              deliveryStreamName: 'deliveryStreamName',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
              separator: 'separator',
            },
            iotEvents: {
              inputName: 'inputName',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
            },
            iotSiteWise: {
              propertyValue: {
                value: {
                  booleanValue: 'booleanValue',
                  doubleValue: 'doubleValue',
                  integerValue: 'integerValue',
                  stringValue: 'stringValue',
                },

                // the properties below are optional
                quality: 'quality',
                timestamp: {
                  timeInSeconds: 'timeInSeconds',

                  // the properties below are optional
                  offsetInNanos: 'offsetInNanos',
                },
              },

              // the properties below are optional
              assetId: 'assetId',
              entryId: 'entryId',
              propertyAlias: 'propertyAlias',
              propertyId: 'propertyId',
            },
            iotTopicPublish: {
              mqttTopic: 'mqttTopic',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
            },
            lambda: {
              functionArn: 'functionArn',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
            },
            resetTimer: {
              timerName: 'timerName',
            },
            setTimer: {
              timerName: 'timerName',

              // the properties below are optional
              durationExpression: 'durationExpression',
              seconds: 123,
            },
            setVariable: {
              value: 'value',
              variableName: 'variableName',
            },
            sns: {
              targetArn: 'targetArn',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
            },
            sqs: {
              queueUrl: 'queueUrl',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
              useBase64: false,
            },
          }],
          condition: 'condition',
        }],
      },
      onInput: {
        events: [{
          eventName: 'eventName',

          // the properties below are optional
          actions: [{
            clearTimer: {
              timerName: 'timerName',
            },
            dynamoDb: {
              hashKeyField: 'hashKeyField',
              hashKeyValue: 'hashKeyValue',
              tableName: 'tableName',

              // the properties below are optional
              hashKeyType: 'hashKeyType',
              operation: 'operation',
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
              payloadField: 'payloadField',
              rangeKeyField: 'rangeKeyField',
              rangeKeyType: 'rangeKeyType',
              rangeKeyValue: 'rangeKeyValue',
            },
            dynamoDBv2: {
              tableName: 'tableName',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
            },
            firehose: {
              deliveryStreamName: 'deliveryStreamName',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
              separator: 'separator',
            },
            iotEvents: {
              inputName: 'inputName',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
            },
            iotSiteWise: {
              propertyValue: {
                value: {
                  booleanValue: 'booleanValue',
                  doubleValue: 'doubleValue',
                  integerValue: 'integerValue',
                  stringValue: 'stringValue',
                },

                // the properties below are optional
                quality: 'quality',
                timestamp: {
                  timeInSeconds: 'timeInSeconds',

                  // the properties below are optional
                  offsetInNanos: 'offsetInNanos',
                },
              },

              // the properties below are optional
              assetId: 'assetId',
              entryId: 'entryId',
              propertyAlias: 'propertyAlias',
              propertyId: 'propertyId',
            },
            iotTopicPublish: {
              mqttTopic: 'mqttTopic',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
            },
            lambda: {
              functionArn: 'functionArn',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
            },
            resetTimer: {
              timerName: 'timerName',
            },
            setTimer: {
              timerName: 'timerName',

              // the properties below are optional
              durationExpression: 'durationExpression',
              seconds: 123,
            },
            setVariable: {
              value: 'value',
              variableName: 'variableName',
            },
            sns: {
              targetArn: 'targetArn',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
            },
            sqs: {
              queueUrl: 'queueUrl',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
              useBase64: false,
            },
          }],
          condition: 'condition',
        }],
        transitionEvents: [{
          condition: 'condition',
          eventName: 'eventName',
          nextState: 'nextState',

          // the properties below are optional
          actions: [{
            clearTimer: {
              timerName: 'timerName',
            },
            dynamoDb: {
              hashKeyField: 'hashKeyField',
              hashKeyValue: 'hashKeyValue',
              tableName: 'tableName',

              // the properties below are optional
              hashKeyType: 'hashKeyType',
              operation: 'operation',
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
              payloadField: 'payloadField',
              rangeKeyField: 'rangeKeyField',
              rangeKeyType: 'rangeKeyType',
              rangeKeyValue: 'rangeKeyValue',
            },
            dynamoDBv2: {
              tableName: 'tableName',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
            },
            firehose: {
              deliveryStreamName: 'deliveryStreamName',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
              separator: 'separator',
            },
            iotEvents: {
              inputName: 'inputName',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
            },
            iotSiteWise: {
              propertyValue: {
                value: {
                  booleanValue: 'booleanValue',
                  doubleValue: 'doubleValue',
                  integerValue: 'integerValue',
                  stringValue: 'stringValue',
                },

                // the properties below are optional
                quality: 'quality',
                timestamp: {
                  timeInSeconds: 'timeInSeconds',

                  // the properties below are optional
                  offsetInNanos: 'offsetInNanos',
                },
              },

              // the properties below are optional
              assetId: 'assetId',
              entryId: 'entryId',
              propertyAlias: 'propertyAlias',
              propertyId: 'propertyId',
            },
            iotTopicPublish: {
              mqttTopic: 'mqttTopic',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
            },
            lambda: {
              functionArn: 'functionArn',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
            },
            resetTimer: {
              timerName: 'timerName',
            },
            setTimer: {
              timerName: 'timerName',

              // the properties below are optional
              durationExpression: 'durationExpression',
              seconds: 123,
            },
            setVariable: {
              value: 'value',
              variableName: 'variableName',
            },
            sns: {
              targetArn: 'targetArn',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
            },
            sqs: {
              queueUrl: 'queueUrl',

              // the properties below are optional
              payload: {
                contentExpression: 'contentExpression',
                type: 'type',
              },
              useBase64: false,
            },
          }],
        }],
      },
    }],
  },
  roleArn: 'roleArn',

  // the properties below are optional
  detectorModelDescription: 'detectorModelDescription',
  detectorModelName: 'detectorModelName',
  evaluationMethod: 'evaluationMethod',
  key: 'key',
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnDetectorModel(scope: Construct, id: string, props: CfnDetectorModelProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnDetectorModelProps — - resource properties.

Create a new AWS::IoTEvents::DetectorModel.

Construct Props

NameTypeDescription
detectorModelDefinitionIResolvable | DetectorModelDefinitionPropertyInformation that defines how a detector operates.
roleArnstringThe ARN of the role that grants permission to AWS IoT Events to perform its operations.
detectorModelDescription?stringA brief description of the detector model.
detectorModelName?stringThe name of the detector model.
evaluationMethod?stringInformation about the order in which events are evaluated and how actions are executed.
key?stringThe value used to identify a detector instance.
tags?CfnTag[]An array of key-value pairs to apply to this resource.

detectorModelDefinition

Type: IResolvable | DetectorModelDefinitionProperty

Information that defines how a detector operates.

roleArn

Type: string

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

detectorModelDescription?

Type: string (optional)

A brief description of the detector model.

detectorModelName?

Type: string (optional)

The name of the detector model.

evaluationMethod?

Type: string (optional)

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

key?

Type: string (optional)

The value used to identify a detector instance.

When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information.

This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.

tags?

Type: CfnTag[] (optional)

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

For more information, see Tag .

Properties

NameTypeDescription
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
detectorModelDefinitionIResolvable | DetectorModelDefinitionPropertyInformation that defines how a detector operates.
logicalIdstringThe logical ID for this CloudFormation stack element.
nodeConstructNodeThe construct tree node associated with this construct.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
roleArnstringThe ARN of the role that grants permission to AWS IoT Events to perform its operations.
stackStackThe stack in which this element is defined.
tagsTagManagerAn array of key-value pairs to apply to this resource.
detectorModelDescription?stringA brief description of the detector model.
detectorModelName?stringThe name of the detector model.
evaluationMethod?stringInformation about the order in which events are evaluated and how actions are executed.
key?stringThe value used to identify a detector instance.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

detectorModelDefinition

Type: IResolvable | DetectorModelDefinitionProperty

Information that defines how a detector operates.

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

roleArn

Type: string

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

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Type: TagManager

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

For more information, see Tag .

detectorModelDescription?

Type: string (optional)

A brief description of the detector model.

detectorModelName?

Type: string (optional)

The name of the detector model.

evaluationMethod?

Type: string (optional)

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

key?

Type: string (optional)

The value used to identify a detector instance.

When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information.

This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependsOn(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

  • attributeName string — The name of the attribute.

Returns

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }
← PreviousNext →