

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

# AWS::KinesisVideo::SignalingChannel
<a name="aws-resource-kinesisvideo-signalingchannel"></a>

Specifies a signaling channel.

`CreateSignalingChannel` is an asynchronous operation.

## Syntax
<a name="aws-resource-kinesisvideo-signalingchannel-syntax"></a>

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

### JSON
<a name="aws-resource-kinesisvideo-signalingchannel-syntax.json"></a>

```
{
  "Type" : "AWS::KinesisVideo::SignalingChannel",
  "Properties" : {
      "[MessageTtlSeconds](#cfn-kinesisvideo-signalingchannel-messagettlseconds)" : {{Integer}},
      "[Name](#cfn-kinesisvideo-signalingchannel-name)" : {{String}},
      "[Tags](#cfn-kinesisvideo-signalingchannel-tags)" : {{[ Tag, ... ]}},
      "[Type](#cfn-kinesisvideo-signalingchannel-type)" : {{String}}
    }
}
```

### YAML
<a name="aws-resource-kinesisvideo-signalingchannel-syntax.yaml"></a>

```
Type: AWS::KinesisVideo::SignalingChannel
Properties:
  [MessageTtlSeconds](#cfn-kinesisvideo-signalingchannel-messagettlseconds): {{Integer}}
  [Name](#cfn-kinesisvideo-signalingchannel-name): {{String}}
  [Tags](#cfn-kinesisvideo-signalingchannel-tags): {{
    - Tag}}
  [Type](#cfn-kinesisvideo-signalingchannel-type): {{String}}
```

## Properties
<a name="aws-resource-kinesisvideo-signalingchannel-properties"></a>

`MessageTtlSeconds`  <a name="cfn-kinesisvideo-signalingchannel-messagettlseconds"></a>
The period of time (in seconds) a signaling channel retains undelivered messages before they are discarded. Use API\_UpdateSignalingChannel to update this value.  
*Required*: No  
*Type*: Integer  
*Minimum*: `5`  
*Maximum*: `120`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-kinesisvideo-signalingchannel-name"></a>
A name for the signaling channel that you are creating. It must be unique for each Amazon Web Services account and Amazon Web Services Region.  
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z0-9_.-]+`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-kinesisvideo-signalingchannel-tags"></a>
An array of key-value pairs to apply to this resource.  
For more information, see [Tag](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).  
*Required*: No  
*Type*: Array of [Tag](aws-properties-kinesisvideo-signalingchannel-tag.md)  
*Minimum*: `1`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-kinesisvideo-signalingchannel-type"></a>
A type of the signaling channel that you are creating. Currently, `SINGLE_MASTER` is the only supported channel type.   
*Required*: No  
*Type*: String  
*Allowed values*: `SINGLE_MASTER`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-kinesisvideo-signalingchannel-return-values"></a>

### Ref
<a name="aws-resource-kinesisvideo-signalingchannel-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-kinesisvideo-signalingchannel-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-kinesisvideo-signalingchannel-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the signaling channel.