interface CfnChannelProps

Language	Type name
.NET	Amazon.CDK.AWS.MediaTailor.CfnChannelProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsmediatailor#CfnChannelProps
Java	software.amazon.awscdk.services.mediatailor.CfnChannelProps
Python	aws_cdk.aws_mediatailor.CfnChannelProps
TypeScript	aws-cdk-lib » aws_mediatailor » CfnChannelProps

Properties for defining a CfnChannel.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mediatailor as mediatailor } from 'aws-cdk-lib';
const cfnChannelProps: mediatailor.CfnChannelProps = {
  channelName: 'channelName',
  outputs: [{
    manifestName: 'manifestName',
    sourceGroup: 'sourceGroup',

    // the properties below are optional
    dashPlaylistSettings: {
      manifestWindowSeconds: 123,
      minBufferTimeSeconds: 123,
      minUpdatePeriodSeconds: 123,
      suggestedPresentationDelaySeconds: 123,
    },
    hlsPlaylistSettings: {
      adMarkupType: ['adMarkupType'],
      manifestWindowSeconds: 123,
    },
  }],
  playbackMode: 'playbackMode',

  // the properties below are optional
  audiences: ['audiences'],
  fillerSlate: {
    sourceLocationName: 'sourceLocationName',
    vodSourceName: 'vodSourceName',
  },
  logConfiguration: {
    logTypes: ['logTypes'],
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  tier: 'tier',
  timeShiftConfiguration: {
    maxTimeDelaySeconds: 123,
  },
};

Properties

Name	Type	Description
channelName	string	The name of the channel.
outputs	IResolvable | (IResolvable | RequestOutputItemProperty)[]	The channel's output properties.
playbackMode	string	The type of playback mode for this channel.
audiences?	string[]	The list of audiences defined in channel.
fillerSlate?	IResolvable | SlateSourceProperty	The slate used to fill gaps between programs in the schedule.
logConfiguration?	IResolvable | LogConfigurationForChannelProperty	The log configuration.
tags?	CfnTag[]	The tags to assign to the channel.
tier?	string	The tier for this channel.
timeShiftConfiguration?	IResolvable | TimeShiftConfigurationProperty	The configuration for time-shifted viewing.

---

channelName

Type: string

The name of the channel.

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

---

outputs

Type: IResolvable | (IResolvable | RequestOutputItemProperty)[]

The channel's output properties.

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

---

playbackMode

Type: string

The type of playback mode for this channel.

LINEAR - Programs play back-to-back only once.

LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.

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

---

audiences?

Type: string[] (optional)

The list of audiences defined in channel.

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

---

fillerSlate?

Type: IResolvable | SlateSourceProperty (optional)

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

You must configure filler slate if your channel uses the LINEAR PlaybackMode . MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode .

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

---

logConfiguration?

Type: IResolvable | LogConfigurationForChannelProperty (optional)

The log configuration.

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

---

tags?

Type: CfnTag[] (optional)

The tags to assign to the channel.

Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources .

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

---

tier?

Type: string (optional)

The tier for this channel.

STANDARD tier channels can contain live programs.

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

---

timeShiftConfiguration?

Type: IResolvable | TimeShiftConfigurationProperty (optional)

The configuration for time-shifted viewing.

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