Class CfnChannel
A CloudFormation AWS::IVS::Channel
.
Inherited Members
Namespace: Amazon.CDK.AWS.IVS
Assembly: Amazon.CDK.AWS.IVS.dll
Syntax (csharp)
public class CfnChannel : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnChannel
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::IVS::Channel
resource specifies an channel. A channel stores configuration information related to your live stream. For more information, see CreateChannel in the Amazon Interactive Video Service API Reference .
By default, the IVS API CreateChannel endpoint creates a stream key in addition to a channel. The Channel resource does not create a stream key; to create a stream key, use the StreamKey resource instead.
CloudformationResource: AWS::IVS::Channel
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IVS;
var cfnChannel = new CfnChannel(this, "MyCfnChannel", new CfnChannelProps {
Authorized = false,
InsecureIngest = false,
LatencyMode = "latencyMode",
Name = "name",
RecordingConfigurationArn = "recordingConfigurationArn",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Type = "type"
});
Synopsis
Constructors
CfnChannel(Construct, String, ICfnChannelProps) | Create a new |
CfnChannel(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnChannel(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The channel ARN. |
AttrIngestEndpoint | Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software. |
AttrPlaybackUrl | Channel playback URL. |
Authorized | Whether the channel is authorized. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
InsecureIngest | Whether the channel allows insecure RTMP ingest. |
LatencyMode | Channel latency mode. Valid values:. |
Name | Channel name. |
RecordingConfigurationArn | The ARN of a RecordingConfiguration resource. |
Tags | An array of key-value pairs to apply to this resource. |
Type | The channel type, which determines the allowable resolution and bitrate. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnChannel(Construct, String, ICfnChannelProps)
Create a new AWS::IVS::Channel
.
public CfnChannel(Construct scope, string id, ICfnChannelProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnChannelProps
- resource properties.
CfnChannel(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnChannel(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnChannel(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnChannel(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The channel ARN.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example: arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh
CloudformationAttribute: Arn
AttrIngestEndpoint
Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
public virtual string AttrIngestEndpoint { get; }
Property Value
System.String
Remarks
For example: a1b2c3d4e5f6.global-contribute.live-video.net
CloudformationAttribute: IngestEndpoint
AttrPlaybackUrl
Channel playback URL.
public virtual string AttrPlaybackUrl { get; }
Property Value
System.String
Remarks
For example: https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8
CloudformationAttribute: PlaybackUrl
Authorized
Whether the channel is authorized.
public virtual object Authorized { get; set; }
Property Value
System.Object
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
InsecureIngest
Whether the channel allows insecure RTMP ingest.
public virtual object InsecureIngest { get; set; }
Property Value
System.Object
Remarks
LatencyMode
Channel latency mode. Valid values:.
public virtual string LatencyMode { get; set; }
Property Value
System.String
Remarks
In the console, <code>LOW</code> and <code>NORMAL</code> correspond to <code>Ultra-low</code> and <code>Standard</code> , respectively.
Default : LOW
Name
Channel name.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
RecordingConfigurationArn
The ARN of a RecordingConfiguration resource.
public virtual string RecordingConfigurationArn { get; set; }
Property Value
System.String
Remarks
An empty string indicates that recording is disabled for the channel. A RecordingConfiguration ARN indicates that recording is enabled using the specified recording configuration. See the RecordingConfiguration resource for more information and an example.
Default : "" (empty string, recording is disabled)
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag .
Type
The channel type, which determines the allowable resolution and bitrate.
public virtual string Type { get; set; }
Property Value
System.String
Remarks
If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:
Default : STANDARD
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>