interface EventProperty

Language	Type name
.NET	Amazon.CDK.AWS.IoTEvents.CfnDetectorModel.EventProperty
Java	software.amazon.awscdk.services.iotevents.CfnDetectorModel.EventProperty
Python	aws_cdk.aws_iotevents.CfnDetectorModel.EventProperty
TypeScript	@aws-cdk/aws-iotevents » CfnDetectorModel » EventProperty

Specifies the actions to be performed when the condition evaluates to TRUE.

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 eventProperty: iotevents.CfnDetectorModel.EventProperty = {
  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
eventName	string	The name of the event.
actions?	IResolvable | ActionProperty | IResolvable[]	The actions to be performed.
condition?	string	Optional.

---

eventName

Type: string

The name of the event.

---

actions?

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

The actions to be performed.

---

condition?

Type: string (optional)

Optional.

The Boolean expression that, when TRUE, causes the actions to 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).