interface ActionConfig 🔹

Language	Type name
.NET	Amazon.CDK.AWS.IoT.Alpha.ActionConfig
Go	github.com/aws/aws-cdk-go/awscdkiotalpha/v2#ActionConfig
Java	software.amazon.awscdk.services.iot.alpha.ActionConfig
Python	aws_cdk.aws_iot_alpha.ActionConfig
TypeScript (source)	@aws-cdk/aws-iot-alpha » ActionConfig

Properties for an topic rule action.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as iot_alpha from '@aws-cdk/aws-iot-alpha';
const actionConfig: iot_alpha.ActionConfig = {
  configuration: {
    cloudwatchAlarm: {
      alarmName: 'alarmName',
      roleArn: 'roleArn',
      stateReason: 'stateReason',
      stateValue: 'stateValue',
    },
    cloudwatchLogs: {
      logGroupName: 'logGroupName',
      roleArn: 'roleArn',

      // the properties below are optional
      batchMode: false,
    },
    cloudwatchMetric: {
      metricName: 'metricName',
      metricNamespace: 'metricNamespace',
      metricUnit: 'metricUnit',
      metricValue: 'metricValue',
      roleArn: 'roleArn',

      // the properties below are optional
      metricTimestamp: 'metricTimestamp',
    },
    dynamoDb: {
      hashKeyField: 'hashKeyField',
      hashKeyValue: 'hashKeyValue',
      roleArn: 'roleArn',
      tableName: 'tableName',

      // the properties below are optional
      hashKeyType: 'hashKeyType',
      payloadField: 'payloadField',
      rangeKeyField: 'rangeKeyField',
      rangeKeyType: 'rangeKeyType',
      rangeKeyValue: 'rangeKeyValue',
    },
    dynamoDBv2: {
      putItem: {
        tableName: 'tableName',
      },
      roleArn: 'roleArn',
    },
    elasticsearch: {
      endpoint: 'endpoint',
      id: 'id',
      index: 'index',
      roleArn: 'roleArn',
      type: 'type',
    },
    firehose: {
      deliveryStreamName: 'deliveryStreamName',
      roleArn: 'roleArn',

      // the properties below are optional
      batchMode: false,
      separator: 'separator',
    },
    http: {
      url: 'url',

      // the properties below are optional
      auth: {
        sigv4: {
          roleArn: 'roleArn',
          serviceName: 'serviceName',
          signingRegion: 'signingRegion',
        },
      },
      confirmationUrl: 'confirmationUrl',
      headers: [{
        key: 'key',
        value: 'value',
      }],
    },
    iotAnalytics: {
      channelName: 'channelName',
      roleArn: 'roleArn',

      // the properties below are optional
      batchMode: false,
    },
    iotEvents: {
      inputName: 'inputName',
      roleArn: 'roleArn',

      // the properties below are optional
      batchMode: false,
      messageId: 'messageId',
    },
    iotSiteWise: {
      putAssetPropertyValueEntries: [{
        propertyValues: [{
          timestamp: {
            timeInSeconds: 'timeInSeconds',

            // the properties below are optional
            offsetInNanos: 'offsetInNanos',
          },
          value: {
            booleanValue: 'booleanValue',
            doubleValue: 'doubleValue',
            integerValue: 'integerValue',
            stringValue: 'stringValue',
          },

          // the properties below are optional
          quality: 'quality',
        }],

        // the properties below are optional
        assetId: 'assetId',
        entryId: 'entryId',
        propertyAlias: 'propertyAlias',
        propertyId: 'propertyId',
      }],
      roleArn: 'roleArn',
    },
    kafka: {
      clientProperties: {
        clientPropertiesKey: 'clientProperties',
      },
      destinationArn: 'destinationArn',
      topic: 'topic',

      // the properties below are optional
      headers: [{
        key: 'key',
        value: 'value',
      }],
      key: 'key',
      partition: 'partition',
    },
    kinesis: {
      roleArn: 'roleArn',
      streamName: 'streamName',

      // the properties below are optional
      partitionKey: 'partitionKey',
    },
    lambda: {
      functionArn: 'functionArn',
    },
    location: {
      deviceId: 'deviceId',
      latitude: 'latitude',
      longitude: 'longitude',
      roleArn: 'roleArn',
      trackerName: 'trackerName',

      // the properties below are optional
      timestamp: {
        value: 'value',

        // the properties below are optional
        unit: 'unit',
      },
    },
    openSearch: {
      endpoint: 'endpoint',
      id: 'id',
      index: 'index',
      roleArn: 'roleArn',
      type: 'type',
    },
    republish: {
      roleArn: 'roleArn',
      topic: 'topic',

      // the properties below are optional
      headers: {
        contentType: 'contentType',
        correlationData: 'correlationData',
        messageExpiry: 'messageExpiry',
        payloadFormatIndicator: 'payloadFormatIndicator',
        responseTopic: 'responseTopic',
        userProperties: [{
          key: 'key',
          value: 'value',
        }],
      },
      qos: 123,
    },
    s3: {
      bucketName: 'bucketName',
      key: 'key',
      roleArn: 'roleArn',

      // the properties below are optional
      cannedAcl: 'cannedAcl',
    },
    sns: {
      roleArn: 'roleArn',
      targetArn: 'targetArn',

      // the properties below are optional
      messageFormat: 'messageFormat',
    },
    sqs: {
      queueUrl: 'queueUrl',
      roleArn: 'roleArn',

      // the properties below are optional
      useBase64: false,
    },
    stepFunctions: {
      roleArn: 'roleArn',
      stateMachineName: 'stateMachineName',

      // the properties below are optional
      executionNamePrefix: 'executionNamePrefix',
    },
    timestream: {
      databaseName: 'databaseName',
      dimensions: [{
        name: 'name',
        value: 'value',
      }],
      roleArn: 'roleArn',
      tableName: 'tableName',

      // the properties below are optional
      timestamp: {
        unit: 'unit',
        value: 'value',
      },
    },
  },
};

Properties

Name	Type	Description
configuration🔹	ActionProperty	The configuration for this action.

---

configuration🔹

Type: ActionProperty

The configuration for this action.