Skip to content
v2.275.0

ActivityProperty Struct ​

An activity that performs a transformation on a message.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iotanalytics as iotanalytics } from 'aws-cdk-lib';
const activityProperty: iotanalytics.CfnPipeline.ActivityProperty = {
  addAttributes: {
    attributes: {
      attributesKey: 'attributes',
    },
    name: 'name',

    // the properties below are optional
    next: 'next',
  },
  channel: {
    channelName: 'channelName',
    name: 'name',

    // the properties below are optional
    next: 'next',
  },
  datastore: {
    datastoreName: 'datastoreName',
    name: 'name',
  },
  deviceRegistryEnrich: {
    attribute: 'attribute',
    name: 'name',
    roleArn: 'roleArn',
    thingName: 'thingName',

    // the properties below are optional
    next: 'next',
  },
  deviceShadowEnrich: {
    attribute: 'attribute',
    name: 'name',
    roleArn: 'roleArn',
    thingName: 'thingName',

    // the properties below are optional
    next: 'next',
  },
  filter: {
    filter: 'filter',
    name: 'name',

    // the properties below are optional
    next: 'next',
  },
  lambda: {
    batchSize: 123,
    lambdaName: 'lambdaName',
    name: 'name',

    // the properties below are optional
    next: 'next',
  },
  math: {
    attribute: 'attribute',
    math: 'math',
    name: 'name',

    // the properties below are optional
    next: 'next',
  },
  removeAttributes: {
    attributes: ['attributes'],
    name: 'name',

    // the properties below are optional
    next: 'next',
  },
  selectAttributes: {
    attributes: ['attributes'],
    name: 'name',

    // the properties below are optional
    next: 'next',
  },
};

Properties ​

addAttributesoptionalIResolvable | CfnPipeline.AddAttributesPropertyadd_attributesoptionaltyping.Union[IResolvable, AddAttributesProperty]addAttributesoptionalIResolvableAddAttributesoptionalIResolvableAddAttributesoptionalinterface{}#
Adds other attributes based on existing attributes in the message.
channeloptionalIResolvable | CfnPipeline.ChannelPropertychanneloptionaltyping.Union[IResolvable, ChannelProperty]channeloptionalIResolvableChanneloptionalIResolvableChanneloptionalinterface{}#
Determines the source of the messages to be processed.
datastoreoptionalIResolvable | CfnPipeline.DatastorePropertydatastoreoptionaltyping.Union[IResolvable, DatastoreProperty]datastoreoptionalIResolvableDatastoreoptionalIResolvableDatastoreoptionalinterface{}#
Specifies where to store the processed message data.
deviceRegistryEnrichoptionalIResolvable | CfnPipeline.DeviceRegistryEnrichPropertydevice_registry_enrichoptionaltyping.Union[IResolvable, DeviceRegistryEnrichProperty]deviceRegistryEnrichoptionalIResolvableDeviceRegistryEnrichoptionalIResolvableDeviceRegistryEnrichoptionalinterface{}#
Adds data from the AWS IoT device registry to your message.
deviceShadowEnrichoptionalIResolvable | CfnPipeline.DeviceShadowEnrichPropertydevice_shadow_enrichoptionaltyping.Union[IResolvable, DeviceShadowEnrichProperty]deviceShadowEnrichoptionalIResolvableDeviceShadowEnrichoptionalIResolvableDeviceShadowEnrichoptionalinterface{}#
Adds information from the AWS IoT Device Shadows service to a message.
filteroptionalIResolvable | CfnPipeline.FilterPropertyfilteroptionaltyping.Union[IResolvable, FilterProperty]filteroptionalIResolvableFilteroptionalIResolvableFilteroptionalinterface{}#
Filters a message based on its attributes.
lambdaoptionalIResolvable | CfnPipeline.LambdaPropertylambdaoptionaltyping.Union[IResolvable, LambdaProperty]lambdaoptionalIResolvableLambdaoptionalIResolvableLambdaoptionalinterface{}#
Runs a Lambda function to modify the message.
mathoptionalIResolvable | CfnPipeline.MathPropertymathoptionaltyping.Union[IResolvable, MathProperty]mathoptionalIResolvableMathoptionalIResolvableMathoptionalinterface{}#
Computes an arithmetic expression using the message's attributes and adds it to the message.
removeAttributesoptionalIResolvable | CfnPipeline.RemoveAttributesPropertyremove_attributesoptionaltyping.Union[IResolvable, RemoveAttributesProperty]removeAttributesoptionalIResolvableRemoveAttributesoptionalIResolvableRemoveAttributesoptionalinterface{}#
Removes attributes from a message.
selectAttributesoptionalIResolvable | CfnPipeline.SelectAttributesPropertyselect_attributesoptionaltyping.Union[IResolvable, SelectAttributesProperty]selectAttributesoptionalIResolvableSelectAttributesoptionalIResolvableSelectAttributesoptionalinterface{}#
Creates a new message using only the specified attributes from the original message.