Specifies a signaling channel.
CreateSignalingChannel is an asynchronous operation.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::KinesisVideo::SignalingChannel",
"Properties" : {
"MessageTtlSeconds" : Integer,
"Name" : String,
"Tags" : [ Tag, ... ],
"Type" : String
}
}
YAML
Type: AWS::KinesisVideo::SignalingChannel
Properties:
MessageTtlSeconds: Integer
Name: String
Tags:
- Tag
Type: String
Properties
MessageTtlSeconds-
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:
5Maximum:
120Update requires: No interruption
Name-
A name for the signaling channel that you are creating. It must be unique for each AWS account and AWS Region.
Required: No
Type: String
Pattern:
[a-zA-Z0-9_.-]+Minimum:
1Maximum:
256Update requires: Replacement
-
An array of key-value pairs to apply to this resource.
For more information, see Tag.
Required: No
Type: Array of Tag
Minimum:
1Maximum:
50Update requires: No interruption
Type-
A type of the signaling channel that you are creating. Currently,
SINGLE_MASTERis the only supported channel type.Required: No
Type: String
Allowed values:
SINGLE_MASTERUpdate requires: No interruption
Return values
Ref
Fn::GetAtt
Arn-
The Amazon Resource Name (ARN) of the signaling channel.
