interface CfnPipelineProps

Language	Type name
.NET	Amazon.CDK.AWS.IoTAnalytics.CfnPipelineProps
Java	software.amazon.awscdk.services.iotanalytics.CfnPipelineProps
Python	aws_cdk.aws_iotanalytics.CfnPipelineProps
TypeScript	@aws-cdk/aws-iotanalytics » CfnPipelineProps

Properties for defining a CfnPipeline.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as iotanalytics from '@aws-cdk/aws-iotanalytics';
const cfnPipelineProps: iotanalytics.CfnPipelineProps = {
  pipelineActivities: [{
    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',
    },
  }],

  // the properties below are optional
  pipelineName: 'pipelineName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
pipelineActivities	IResolvable | IResolvable | ActivityProperty[]	A list of "PipelineActivity" objects.
pipelineName?	string	The name of the pipeline.
tags?	CfnTag[]	Metadata which can be used to manage the pipeline.

---

pipelineActivities

Type: 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": { ... } }, ... ]

---

pipelineName?

Type: string (optional)

The name of the pipeline.

---

tags?

Type: CfnTag[] (optional)

Metadata which can be used to manage the pipeline.

For more information, see Tag .