aws-cdk-lib.aws_iotevents.CfnAlarmModel.AlarmActionProperty

interface AlarmActionProperty

LanguageType name
.NETAmazon.CDK.AWS.IoTEvents.CfnAlarmModel.AlarmActionProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiotevents#CfnAlarmModel_AlarmActionProperty
Javasoftware.amazon.awscdk.services.iotevents.CfnAlarmModel.AlarmActionProperty
Pythonaws_cdk.aws_iotevents.CfnAlarmModel.AlarmActionProperty
TypeScript aws-cdk-lib » aws_iotevents » CfnAlarmModel » AlarmActionProperty

Specifies one of the following actions to receive notifications when the alarm state changes.

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 alarmActionProperty: iotevents.CfnAlarmModel.AlarmActionProperty = {
  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

NameTypeDescription
dynamoDBv2?IResolvable | DynamoDBv2PropertyDefines an action to write to the Amazon DynamoDB table that you created.
dynamoDb?IResolvable | DynamoDBPropertyDefines an action to write to the Amazon DynamoDB table that you created.
firehose?IResolvable | FirehosePropertySends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
iotEvents?IResolvable | IotEventsPropertySends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
iotSiteWise?IResolvable | IotSiteWisePropertySends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise .
iotTopicPublish?IResolvable | IotTopicPublishPropertyInformation required to publish the MQTT message through the AWS IoT message broker.
lambda?IResolvable | LambdaPropertyCalls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
sns?IResolvable | SnsPropertyInformation required to publish the Amazon SNS message.
sqs?IResolvable | SqsPropertySends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.

dynamoDBv2?

Type: IResolvable | DynamoDBv2Property (optional)

Defines an action to write to the Amazon DynamoDB table that you created.

The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload . A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.

You must use expressions for all parameters in DynamoDBv2Action . The expressions accept literals, operators, functions, references, and substitution templates.

Examples - For literal values, the expressions must contain single quotes. For example, the value for the tableName parameter can be 'GreenhouseTemperatureTable' .

  • For references, you must specify either variables or input values. For example, the value for the tableName parameter can be $variable.ddbtableName .
  • For a substitution template, you must use ${} , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

In the following example, the value for the contentExpression parameter in Payload uses a substitution template.

'{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'

  • For a string concatenation, you must use + . A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.

In the following example, the value for the tableName parameter uses a string concatenation.

'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

For more information, see Expressions in the AWS IoT Events Developer Guide .

The value for the type parameter in Payload must be JSON .


dynamoDb?

Type: IResolvable | DynamoDBProperty (optional)

Defines an action to write to the Amazon DynamoDB table that you created.

The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload . One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.

You must use expressions for all parameters in DynamoDBAction . The expressions accept literals, operators, functions, references, and substitution templates.

Examples - For literal values, the expressions must contain single quotes. For example, the value for the hashKeyType parameter can be 'STRING' .

  • For references, you must specify either variables or input values. For example, the value for the hashKeyField parameter can be $input.GreenhouseInput.name .
  • For a substitution template, you must use ${} , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

In the following example, the value for the hashKeyValue parameter uses a substitution template.

'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'

  • For a string concatenation, you must use + . A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.

In the following example, the value for the tableName parameter uses a string concatenation.

'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

For more information, see Expressions in the AWS IoT Events Developer Guide .

If the defined payload type is a string, DynamoDBAction writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the payloadField parameter is <payload-field>_raw .


firehose?

Type: IResolvable | FirehoseProperty (optional)

Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.


iotEvents?

Type: IResolvable | IotEventsProperty (optional)

Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.


iotSiteWise?

Type: IResolvable | IotSiteWiseProperty (optional)

Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise .

You must use expressions for all parameters in IotSiteWiseAction . The expressions accept literals, operators, functions, references, and substitutions templates.

Examples - For literal values, the expressions must contain single quotes. For example, the value for the propertyAlias parameter can be '/company/windfarm/3/turbine/7/temperature' .

  • For references, you must specify either variables or input values. For example, the value for the assetId parameter can be $input.TurbineInput.assetId1 .
  • For a substitution template, you must use ${} , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

In the following example, the value for the propertyAlias parameter uses a substitution template.

'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'

You must specify either propertyAlias or both assetId and propertyId to identify the target asset property in AWS IoT SiteWise .

For more information, see Expressions in the AWS IoT Events Developer Guide .


iotTopicPublish?

Type: IResolvable | IotTopicPublishProperty (optional)

Information required to publish the MQTT message through the AWS IoT message broker.


lambda?

Type: IResolvable | LambdaProperty (optional)

Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.


sns?

Type: IResolvable | SnsProperty (optional)

Information required to publish the Amazon SNS message.


sqs?

Type: IResolvable | SqsProperty (optional)

Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.