AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::IoTAnalytics::Channel

CfnChannel

The AWS::IoTAnalytics::Channel resource collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline. 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 { CfnChannel } from 'aws-cdk-lib/aws-iotanalytics';

Or use the module namespace:

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

Properties

Configuration passed to the constructor as CfnChannelProps.

channelNameOptional
string

The name of the channel.

channelStorageOptional
IResolvable | ChannelStorageProperty

Where channel data is stored.

retentionPeriodOptional
IResolvable | RetentionPeriodProperty

How long, in days, message data is kept for the channel.

tagsOptional
CfnTag[]

Metadata which can be used to manage the channel. 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.

AWS::IoTAnalytics::ChannelView in CloudFormation Explorer

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::Channel
Properties4

Related Constructs

Explore This Service

External Links