Class CfnChannel

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnChannel

Implements

IInspectable

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

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 <em>does not</em> 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,
                 ContainerFormat = "containerFormat",
                 InsecureIngest = false,
                 LatencyMode = "latencyMode",
                 MultitrackInputConfiguration = new MultitrackInputConfigurationProperty {
                     Enabled = false,
                     MaximumResolution = "maximumResolution",
                     Policy = "policy"
                 },
                 Name = "name",
                 Preset = "preset",
                 RecordingConfigurationArn = "recordingConfigurationArn",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Type = "type"
             });

Synopsis

Constructors

CfnChannel(Construct, string, ICfnChannelProps?)

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

Properties

AttrArn	Channel ARN is automatically generated on creation and assigned as the unique identifier.
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	The AWS::IVS::Channel resource specifies an channel.
ContainerFormat	Indicates which content-packaging format is used (MPEG-TS or fMP4).
InsecureIngest	Whether the channel allows insecure ingest.
LatencyMode	Channel latency mode.
MultitrackInputConfiguration	Object specifying multitrack input configuration.
Name	Channel.
Preset	Optional transcode preset for the channel.
RecordingConfigurationArn	Recording Configuration ARN.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	A list of key-value pairs that contain metadata for the asset model.
Type	Channel type, which determines the allowable resolution and bitrate.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	The AWS::IVS::Channel resource specifies an channel.

Constructors

CfnChannel(Construct, string, ICfnChannelProps?)

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

public CfnChannel(Construct scope, string id, ICfnChannelProps? props = null)

Parameters

scope Construct

Scope in which this resource is defined.

id string

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

props ICfnChannelProps

Resource properties.

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 <em>does not</em> 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

Properties

AttrArn

Channel ARN is automatically generated on creation and assigned as the unique identifier.

public virtual string AttrArn { get; }

Property Value

string

Remarks

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

string

Remarks

CloudformationAttribute: IngestEndpoint

AttrPlaybackUrl

Channel Playback URL.

public virtual string AttrPlaybackUrl { get; }

Property Value

string

Remarks

CloudformationAttribute: PlaybackUrl

Authorized

Whether the channel is authorized.

public virtual object? Authorized { get; set; }

Property Value

object

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 <em>does not</em> 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

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

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 <em>does not</em> 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

CfnProperties

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

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

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 <em>does not</em> 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

ContainerFormat

Indicates which content-packaging format is used (MPEG-TS or fMP4).

public virtual string? ContainerFormat { get; set; }

Property Value

string

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 <em>does not</em> 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

InsecureIngest

Whether the channel allows insecure ingest.

public virtual object? InsecureIngest { get; set; }

Property Value

object

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 <em>does not</em> 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

LatencyMode

Channel latency mode.

public virtual string? LatencyMode { get; set; }

Property Value

string

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 <em>does not</em> 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

MultitrackInputConfiguration

Object specifying multitrack input configuration.

public virtual object? MultitrackInputConfiguration { get; set; }

Property Value

object

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 <em>does not</em> 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

Name

Channel.

public virtual string? Name { get; set; }

Property Value

string

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 <em>does not</em> 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

Preset

Optional transcode preset for the channel.

public virtual string? Preset { get; set; }

Property Value

string

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 <em>does not</em> 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

RecordingConfigurationArn

Recording Configuration ARN.

public virtual string? RecordingConfigurationArn { get; set; }

Property Value

string

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 <em>does not</em> 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

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

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 <em>does not</em> 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

TagsRaw

A list of key-value pairs that contain metadata for the asset model.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

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 <em>does not</em> 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

Type

Channel type, which determines the allowable resolution and bitrate.

public virtual string? Type { get; set; }

Property Value

string

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 <em>does not</em> 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

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.

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 <em>does not</em> 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

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

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 <em>does not</em> 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

Implements

IInspectable

ITaggable