Class CfnChannel

The configuration parameters for a channel.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnChannel

Implements

IInspectable

ITaggableV2

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

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnChannel : CfnResource, IInspectable, ITaggableV2

Syntax (vb)

Public Class CfnChannel Inherits CfnResource Implements IInspectable, ITaggableV2

Remarks

For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .

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

CloudformationResource: AWS::MediaTailor::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.MediaTailor;

             var cfnChannel = new CfnChannel(this, "MyCfnChannel", new CfnChannelProps {
                 ChannelName = "channelName",
                 Outputs = new [] { new RequestOutputItemProperty {
                     ManifestName = "manifestName",
                     SourceGroup = "sourceGroup",

                     // the properties below are optional
                     DashPlaylistSettings = new DashPlaylistSettingsProperty {
                         ManifestWindowSeconds = 123,
                         MinBufferTimeSeconds = 123,
                         MinUpdatePeriodSeconds = 123,
                         SuggestedPresentationDelaySeconds = 123
                     },
                     HlsPlaylistSettings = new HlsPlaylistSettingsProperty {
                         AdMarkupType = new [] { "adMarkupType" },
                         ManifestWindowSeconds = 123
                     }
                 } },
                 PlaybackMode = "playbackMode",

                 // the properties below are optional
                 Audiences = new [] { "audiences" },
                 FillerSlate = new SlateSourceProperty {
                     SourceLocationName = "sourceLocationName",
                     VodSourceName = "vodSourceName"
                 },
                 LogConfiguration = new LogConfigurationForChannelProperty {
                     LogTypes = new [] { "logTypes" }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Tier = "tier",
                 TimeShiftConfiguration = new TimeShiftConfigurationProperty {
                     MaxTimeDelaySeconds = 123
                 }
             });

Synopsis

Constructors

CfnChannel(Construct, string, ICfnChannelProps)

The configuration parameters for a channel.

Properties

AttrArn	<p>The ARN of the channel.</p>.
Audiences	The list of audiences defined in channel.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	The configuration parameters for a channel.
ChannelName	The name of the channel.
FillerSlate	The slate used to fill gaps between programs in the schedule.
LogConfiguration	The log configuration.
Outputs	The channel's output properties.
PlaybackMode	The type of playback mode for this channel.
Tags	The tags to assign to the channel.
Tier	The tier for this channel.
TimeShiftConfiguration	The configuration for time-shifted viewing.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	The configuration parameters for a channel.

Constructors

CfnChannel(Construct, string, ICfnChannelProps)

The configuration parameters for a channel.

public CfnChannel(Construct scope, string id, ICfnChannelProps props)

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

For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .

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

CloudformationResource: AWS::MediaTailor::Channel

ExampleMetadata: fixture=_generated

Properties

AttrArn

<p>The ARN of the channel.</p>.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

Audiences

The list of audiences defined in channel.

public virtual string[]? Audiences { get; set; }

Property Value

string[]

Remarks

For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .

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

CloudformationResource: AWS::MediaTailor::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

For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .

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

CloudformationResource: AWS::MediaTailor::Channel

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .

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

CloudformationResource: AWS::MediaTailor::Channel

ExampleMetadata: fixture=_generated

CfnProperties

The configuration parameters for a channel.

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .

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

CloudformationResource: AWS::MediaTailor::Channel

ExampleMetadata: fixture=_generated

ChannelName

The name of the channel.

public virtual string ChannelName { get; set; }

Property Value

string

Remarks

For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .

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

CloudformationResource: AWS::MediaTailor::Channel

ExampleMetadata: fixture=_generated

FillerSlate

The slate used to fill gaps between programs in the schedule.

public virtual object? FillerSlate { get; set; }

Property Value

object

Remarks

For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .

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

CloudformationResource: AWS::MediaTailor::Channel

ExampleMetadata: fixture=_generated

LogConfiguration

The log configuration.

public virtual object? LogConfiguration { get; set; }

Property Value

object

Remarks

For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .

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

CloudformationResource: AWS::MediaTailor::Channel

ExampleMetadata: fixture=_generated

Outputs

The channel's output properties.

public virtual object Outputs { get; set; }

Property Value

object

Remarks

For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .

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

CloudformationResource: AWS::MediaTailor::Channel

ExampleMetadata: fixture=_generated

PlaybackMode

The type of playback mode for this channel.

public virtual string PlaybackMode { get; set; }

Property Value

string

Remarks

For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .

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

CloudformationResource: AWS::MediaTailor::Channel

ExampleMetadata: fixture=_generated

Tags

The tags to assign to the channel.

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

Property Value

ICfnTag[]

Remarks

For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .

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

CloudformationResource: AWS::MediaTailor::Channel

ExampleMetadata: fixture=_generated

Tier

The tier for this channel.

public virtual string? Tier { get; set; }

Property Value

string

Remarks

For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .

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

CloudformationResource: AWS::MediaTailor::Channel

ExampleMetadata: fixture=_generated

TimeShiftConfiguration

The configuration for time-shifted viewing.

public virtual object? TimeShiftConfiguration { get; set; }

Property Value

object

Remarks

For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .

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

CloudformationResource: AWS::MediaTailor::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

For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .

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

CloudformationResource: AWS::MediaTailor::Channel

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The configuration parameters for a 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

For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .

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

CloudformationResource: AWS::MediaTailor::Channel

ExampleMetadata: fixture=_generated

Implements

IInspectable

ITaggableV2