@aws-cdk/aws-iotevents-alpha.Event

Experimental

@aws-cdk/aws-iotevents-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

Event Struct

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

Stability

Experimental

Source

lib/event.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as iotevents_alpha from '@aws-cdk/aws-iotevents-alpha';

declare const action: iotevents_alpha.IAction;
declare const expression: iotevents_alpha.Expression;
const event: iotevents_alpha.Event = {
  eventName: 'eventName',

  // the properties below are optional
  actions: [action],
  condition: expression,
};

Properties

actions?optionalIAction[]actions?optionaltyping.List[IAction]actions?optionalList<IAction>Actions?optionalIAction[]Actions?optional*[]IAction#

The actions to be performed.

Default: no actions will be performed

condition?optionalExpressioncondition?optionalExpressioncondition?optionalExpressionCondition?optionalExpressionCondition?optionalExpression#

The Boolean expression that, when `true`, causes the actions to be performed.

Default: none (the actions are always executed)

eventNamestringevent_namestreventNameStringEventNamestringEventName*stringrequired#

The name of the event.