interface OnEnterProperty

Language	Type name
.NET	Amazon.CDK.AWS.IoTEvents.CfnDetectorModel.OnEnterProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsiotevents#CfnDetectorModel_OnEnterProperty
Java	software.amazon.awscdk.services.iotevents.CfnDetectorModel.OnEnterProperty
Python	aws_cdk.aws_iotevents.CfnDetectorModel.OnEnterProperty
TypeScript	aws-cdk-lib » aws_iotevents » CfnDetectorModel » OnEnterProperty

When entering this state, perform these actions if the condition is TRUE.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-onenter.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iotevents as iotevents } from 'aws-cdk-lib';
const onEnterProperty: iotevents.CfnDetectorModel.OnEnterProperty = {
  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',
  }],
};

Properties

Name	Type	Description
events?	IResolvable | (IResolvable | EventProperty)[]	Specifies the actions that are performed when the state is entered and the condition is TRUE .

---

events?

Type: IResolvable | (IResolvable | EventProperty)[] (optional)

Specifies the actions that are performed when the state is entered and the condition is TRUE .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-detectormodel-onenter.html#cfn-iotevents-detectormodel-onenter-events