This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::IoTAnalytics::Channel
<a name="aws-resource-iotanalytics-channel"></a>

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](https://docs.aws.amazon.com/iotanalytics/latest/userguide/welcome.html#aws-iot-analytics-how) in the *AWS IoT Analytics User Guide*. 

## Syntax
<a name="aws-resource-iotanalytics-channel-syntax"></a>

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

### JSON
<a name="aws-resource-iotanalytics-channel-syntax.json"></a>

```
{
  "Type" : "AWS::IoTAnalytics::Channel",
  "Properties" : {
      "[ChannelName](#cfn-iotanalytics-channel-channelname)" : String,
      "[ChannelStorage](#cfn-iotanalytics-channel-channelstorage)" : ChannelStorage,
      "[RetentionPeriod](#cfn-iotanalytics-channel-retentionperiod)" : RetentionPeriod,
      "[Tags](#cfn-iotanalytics-channel-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-iotanalytics-channel-syntax.yaml"></a>

```
Type: AWS::IoTAnalytics::Channel
Properties:
  [ChannelName](#cfn-iotanalytics-channel-channelname): String
  [ChannelStorage](#cfn-iotanalytics-channel-channelstorage): 
    ChannelStorage
  [RetentionPeriod](#cfn-iotanalytics-channel-retentionperiod): 
    RetentionPeriod
  [Tags](#cfn-iotanalytics-channel-tags): 
    - Tag
```

## Properties
<a name="aws-resource-iotanalytics-channel-properties"></a>

`ChannelName`  <a name="cfn-iotanalytics-channel-channelname"></a>
The name of the channel.  
*Required*: No  
*Type*: String  
*Pattern*: `(^(?!_{2}))(^[a-zA-Z0-9_]+$)`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ChannelStorage`  <a name="cfn-iotanalytics-channel-channelstorage"></a>
Where channel data is stored.  
*Required*: No  
*Type*: [ChannelStorage](aws-properties-iotanalytics-channel-channelstorage.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RetentionPeriod`  <a name="cfn-iotanalytics-channel-retentionperiod"></a>
How long, in days, message data is kept for the channel.  
*Required*: No  
*Type*: [RetentionPeriod](aws-properties-iotanalytics-channel-retentionperiod.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-iotanalytics-channel-tags"></a>
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).  
*Required*: No  
*Type*: Array of [Tag](aws-properties-iotanalytics-channel-tag.md)  
*Minimum*: `1`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Examples
<a name="aws-resource-iotanalytics-channel--examples"></a>



**Topics**
+ [Simple Channel](#aws-resource-iotanalytics-channel--examples--Simple_Channel)
+ [Complex Channel](#aws-resource-iotanalytics-channel--examples--Complex_Channel)

### Simple Channel
<a name="aws-resource-iotanalytics-channel--examples--Simple_Channel"></a>

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

#### JSON
<a name="aws-resource-iotanalytics-channel--examples--Simple_Channel--json"></a>

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

#### YAML
<a name="aws-resource-iotanalytics-channel--examples--Simple_Channel--yaml"></a>

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

### Complex Channel
<a name="aws-resource-iotanalytics-channel--examples--Complex_Channel"></a>

The following example creates a complex channel.

#### JSON
<a name="aws-resource-iotanalytics-channel--examples--Complex_Channel--json"></a>

```
{
    "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
<a name="aws-resource-iotanalytics-channel--examples--Complex_Channel--yaml"></a>

```
---
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
<a name="aws-resource-iotanalytics-channel--seealso"></a>
+ [How to Use AWS IoT Analytics](https://docs.aws.amazon.com/iotanalytics/latest/userguide/welcome.html#aws-iot-analytics-how) in the *AWS IoT Analytics User Guide*
+ [CreateChannel](https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_CreateChannel.html) in the *AWS IoT Analytics API Reference*