AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::IoTAnalytics::Pipeline

CfnPipeline

The AWS::IoTAnalytics::Pipeline resource consumes messages from one or more channels and allows you to process the messages before storing them in a data store. You must specify both a `channel` and a `datastore` activity and, optionally, as many as 23 additional activities in the `pipelineActivities` array. For more information, see [How to Use](https://docs.aws.amazon.com/iotanalytics/latest/userguide/welcome.html#aws-iot-analytics-how) in the *User Guide* .

Import

import { CfnPipeline } from 'aws-cdk-lib/aws-iotanalytics';

Or use the module namespace:

import * as iotanalytics from 'aws-cdk-lib/aws-iotanalytics';
// iotanalytics.CfnPipeline

Properties

Configuration passed to the constructor as CfnPipelineProps.

pipelineActivitiesRequired
IResolvable | IResolvable | ActivityProperty[]

A list of "PipelineActivity" objects. Activities perform transformations on your messages, such as removing, renaming or adding message attributes; filtering messages based on attribute values; invoking your Lambda functions on messages for advanced processing; or performing mathematical transformations to normalize device data. The list can be 2-25 *PipelineActivity* objects and must contain both a `channel` and a `datastore` activity. Each entry in the list must contain only one activity, for example: `pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]`

pipelineNameOptional
string

The name of the pipeline.

tagsOptional
CfnTag[]

Metadata which can be used to manage the pipeline. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-iotanalytics
CFN TypeAWS::IoTAnalytics::Pipeline
Properties3

Related Constructs

External Links