aws-cdk-lib.aws_iotanalytics.CfnPipeline.ActivityProperty

interface ActivityProperty

LanguageType name
.NETAmazon.CDK.AWS.IoTAnalytics.CfnPipeline.ActivityProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiotanalytics#CfnPipeline_ActivityProperty
Javasoftware.amazon.awscdk.services.iotanalytics.CfnPipeline.ActivityProperty
Pythonaws_cdk.aws_iotanalytics.CfnPipeline.ActivityProperty
TypeScript aws-cdk-lib » aws_iotanalytics » CfnPipeline » ActivityProperty

An activity that performs a transformation on a message.

Example

// 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

NameTypeDescription
addAttributes?IResolvable | AddAttributesPropertyAdds other attributes based on existing attributes in the message.
channel?IResolvable | ChannelPropertyDetermines the source of the messages to be processed.
datastore?IResolvable | DatastorePropertySpecifies where to store the processed message data.
deviceRegistryEnrich?IResolvable | DeviceRegistryEnrichPropertyAdds data from the AWS IoT device registry to your message.
deviceShadowEnrich?IResolvable | DeviceShadowEnrichPropertyAdds information from the AWS IoT Device Shadows service to a message.
filter?IResolvable | FilterPropertyFilters a message based on its attributes.
lambda?IResolvable | LambdaPropertyRuns a Lambda function to modify the message.
math?IResolvable | MathPropertyComputes an arithmetic expression using the message's attributes and adds it to the message.
removeAttributes?IResolvable | RemoveAttributesPropertyRemoves attributes from a message.
selectAttributes?IResolvable | SelectAttributesPropertyCreates a new message using only the specified attributes from the original message.

addAttributes?

Type: IResolvable | AddAttributesProperty (optional)

Adds other attributes based on existing attributes in the message.


channel?

Type: IResolvable | ChannelProperty (optional)

Determines the source of the messages to be processed.


datastore?

Type: IResolvable | DatastoreProperty (optional)

Specifies where to store the processed message data.


deviceRegistryEnrich?

Type: IResolvable | DeviceRegistryEnrichProperty (optional)

Adds data from the AWS IoT device registry to your message.


deviceShadowEnrich?

Type: IResolvable | DeviceShadowEnrichProperty (optional)

Adds information from the AWS IoT Device Shadows service to a message.


filter?

Type: IResolvable | FilterProperty (optional)

Filters a message based on its attributes.


lambda?

Type: IResolvable | LambdaProperty (optional)

Runs a Lambda function to modify the message.


math?

Type: IResolvable | MathProperty (optional)

Computes an arithmetic expression using the message's attributes and adds it to the message.


removeAttributes?

Type: IResolvable | RemoveAttributesProperty (optional)

Removes attributes from a message.


selectAttributes?

Type: IResolvable | SelectAttributesProperty (optional)

Creates a new message using only the specified attributes from the original message.