AWS::IoTAnalytics::Channel

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 AWS IoT Analytics in the AWS IoT Analytics User Guide.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::IoTAnalytics::Channel",
  "Properties" : {
      "ChannelName" : String,
      "ChannelStorage" : ChannelStorage,
      "RetentionPeriod" : RetentionPeriod,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::IoTAnalytics::Channel
Properties:
  ChannelName: String
  ChannelStorage: 
    ChannelStorage
  RetentionPeriod: 
    RetentionPeriod
  Tags: 
    - Tag

Properties

ChannelName

The name of the channel.

Required: No

Type: String

Pattern: (^(?!_{2}))(^[a-zA-Z0-9_]+$)

Minimum: 1

Maximum: 128

Update requires: Replacement

ChannelStorage

Where channel data is stored.

Required: No

Type: ChannelStorage

Update requires: No interruption

RetentionPeriod

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

Required: No

Type: RetentionPeriod

Update requires: No interruption

Tags

Metadata which can be used to manage the channel.

For more information, see Tag.

Required: No

Type: Array of Tag

Minimum: 1

Maximum: 50

Update requires: No interruption

Examples

Simple Channel

The following example creates a simple channel that uses service-managed channel storage.

JSON

{
    "Description": "Create a simple Channel",
    "Resources": {
        "Channel": {
            "Type": "AWS::IoTAnalytics::Channel",
            "Properties": {
                "ChannelName": "SimpleChannel"
            }
        }
    }
}

YAML

---
Description: "Create a simple Channel"
Resources:
  Channel:
    Type: "AWS::IoTAnalytics::Channel"
    Properties:
      ChannelName: "SimpleChannel"

Complex Channel

The following example creates a complex channel.

JSON

{
    "Description": "Create a complex channel",
    "Resources": {
        "Channel": {
            "Type": "AWS::IoTAnalytics::Channel",
            "Properties": {
                "ChannelName": "ComplexChannel",
                "RetentionPeriod": {
                    "Unlimited": false,
                    "NumberOfDays": 10
                },
                "Tags": [
                    {
                        "Key": "keyname1",
                        "Value": "value1"
                    },
                    {
                        "Key": "keyname2",
                        "Value": "value2"
                    }
                ]
            }
        }
    }
}

YAML

---
Description: "Create a complex channel"
Resources:
  Channel:
    Type: "AWS::IoTAnalytics::Channel"
    Properties:
      ChannelName: "ComplexChannel"
      RetentionPeriod:
        Unlimited: false
        NumberOfDays: 10
      Tags:
        -
          Key: "keyname1"
          Value: "value1"
        -
          Key: "keyname2"
          Value: "value2"

See also

• How to Use AWS IoT Analytics in the AWS IoT Analytics User Guide

• CreateChannel in the AWS IoT Analytics API Reference