interface AlarmEventActionsProperty

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

Contains information about one or more alarm actions.

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 alarmEventActionsProperty: iotevents.CfnAlarmModel.AlarmEventActionsProperty = {
  alarmActions: [{
    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: {
      assetId: 'assetId',
      entryId: 'entryId',
      propertyAlias: 'propertyAlias',
      propertyId: 'propertyId',
      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',
        },
      },
    },
    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',
      },
    },
    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,
    },
  }],
};

Properties

Name	Type	Description
alarmActions?	`IResolvable` `\|` `IResolvable` `\|` `AlarmActionProperty[]`	Specifies one or more supported actions to receive notifications when the alarm state changes.

alarmActions?

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

Specifies one or more supported actions to receive notifications when the alarm state changes.