Package software.amazon.awscdk.services.mediatailor

Interface CfnChannelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:56:01.927Z")
@Stability(Stable)
public interface CfnChannelProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnChannel.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.mediatailor.*;
 CfnChannelProps cfnChannelProps = CfnChannelProps.builder()
         .channelName("channelName")
         .outputs(List.of(RequestOutputItemProperty.builder()
                 .manifestName("manifestName")
                 .sourceGroup("sourceGroup")
                 // the properties below are optional
                 .dashPlaylistSettings(DashPlaylistSettingsProperty.builder()
                         .manifestWindowSeconds(123)
                         .minBufferTimeSeconds(123)
                         .minUpdatePeriodSeconds(123)
                         .suggestedPresentationDelaySeconds(123)
                         .build())
                 .hlsPlaylistSettings(HlsPlaylistSettingsProperty.builder()
                         .adMarkupType(List.of("adMarkupType"))
                         .manifestWindowSeconds(123)
                         .build())
                 .build()))
         .playbackMode("playbackMode")
         // the properties below are optional
         .audiences(List.of("audiences"))
         .fillerSlate(SlateSourceProperty.builder()
                 .sourceLocationName("sourceLocationName")
                 .vodSourceName("vodSourceName")
                 .build())
         .logConfiguration(LogConfigurationForChannelProperty.builder()
                 .logTypes(List.of("logTypes"))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .tier("tier")
         .timeShiftConfiguration(TimeShiftConfigurationProperty.builder()
                 .maxTimeDelaySeconds(123)
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnChannelProps.Builder	A builder for CfnChannelProps
static final class	CfnChannelProps.Jsii$Proxy	An implementation for CfnChannelProps

Method Summary

Modifier and Type	Method	Description
static CfnChannelProps.Builder	builder()
default List<String>	getAudiences()	The list of audiences defined in channel.
String	getChannelName()	The name of the channel.
default Object	getFillerSlate()	The slate used to fill gaps between programs in the schedule.
default Object	getLogConfiguration()	The log configuration.
Object	getOutputs()	The channel's output properties.
String	getPlaybackMode()	The type of playback mode for this channel.
default List<CfnTag>	getTags()	The tags to assign to the channel.
default String	getTier()	The tier for this channel.
default Object	getTimeShiftConfiguration()	The configuration for time-shifted viewing.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getChannelName

@Stability(Stable)
@NotNull
String getChannelName()

The name of the channel.

See Also:

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

getOutputs

@Stability(Stable)
@NotNull
Object getOutputs()

The channel's output properties.

See Also:

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

getPlaybackMode

@Stability(Stable)
@NotNull
String getPlaybackMode()

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

getAudiences

@Stability(Stable)
@Nullable
default List<String> getAudiences()

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

getFillerSlate

@Stability(Stable)
@Nullable
default Object getFillerSlate()

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

getLogConfiguration

@Stability(Stable)
@Nullable
default Object getLogConfiguration()

The log configuration.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

getTier

@Stability(Stable)
@Nullable
default String getTier()

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

getTimeShiftConfiguration

@Stability(Stable)
@Nullable
default Object getTimeShiftConfiguration()

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

builder

@Stability(Stable)
static CfnChannelProps.Builder builder()

Returns:

a CfnChannelProps.Builder of CfnChannelProps