Class CfnChannel

The AWS::IVS::Channel resource specifies an channel.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnChannel
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Ivs
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnChannel : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnChannel
    Inherits CfnResource
    Implements IInspectable, ITaggable
Remarks

A channel stores configuration information related to your live stream. For more information, see CreateChannel in the Amazon IVS Low-Latency Streaming 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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html

CloudformationResource: AWS::IVS::Channel

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",
    Preset = "preset",
    RecordingConfigurationArn = "recordingConfigurationArn",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    Type = "type"
});

Synopsis

Constructors

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
CfnChannel(Construct, String, ICfnChannelProps)

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.
Name

Channel name.
Preset

An optional transcode preset for the channel.
RecordingConfigurationArn

The ARN of a RecordingConfiguration resource.
Tags

Tag Manager which manages the tags for this resource.
TagsRaw

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(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

CfnChannel(Construct, String, ICfnChannelProps)

public CfnChannel(Construct scope, string id, ICfnChannelProps props = null)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnChannelProps

Resource properties.

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

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

LatencyMode

Channel latency mode.

public virtual string LatencyMode { get; set; }
Property Value

System.String

Remarks

Valid values:.

Name

Channel name.

public virtual string Name { get; set; }
Property Value

System.String

Preset

An optional transcode preset for the channel.

public virtual string Preset { get; set; }
Property Value

System.String

RecordingConfigurationArn

The ARN of a RecordingConfiguration resource.

public virtual string RecordingConfigurationArn { get; set; }
Property Value

System.String

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

TagsRaw

An array of key-value pairs to apply to this resource.

public virtual ICfnTag[] TagsRaw { get; set; }
Property Value

ICfnTag[]

Type

The channel type, which determines the allowable resolution and bitrate.

public virtual string Type { get; set; }
Property Value

System.String

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>

Overrides

Implements