Package software.amazon.awscdk.services.mediatailor

Interface CfnProgramProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProgramProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-10-08T16:59:58.889Z")
@Stability(Stable)
public interface CfnProgramProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnProgram.

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.*;
 CfnProgramProps cfnProgramProps = CfnProgramProps.builder()
         .channelName("channelName")
         .programName("programName")
         .sourceLocationName("sourceLocationName")
         // the properties below are optional
         .adBreaks(List.of(AdBreakProperty.builder()
                 .offsetMillis(123)
                 // the properties below are optional
                 .adBreakMetadata(List.of(KeyValuePairProperty.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .messageType("messageType")
                 .slate(SlateSourceProperty.builder()
                         .sourceLocationName("sourceLocationName")
                         .vodSourceName("vodSourceName")
                         .build())
                 .spliceInsertMessage(SpliceInsertMessageProperty.builder()
                         .availNum(123)
                         .availsExpected(123)
                         .spliceEventId(123)
                         .uniqueProgramId(123)
                         .build())
                 .timeSignalMessage(TimeSignalMessageProperty.builder()
                         .segmentationDescriptors(List.of(SegmentationDescriptorProperty.builder()
                                 .segmentationEventId(123)
                                 .segmentationTypeId(123)
                                 .segmentationUpid("segmentationUpid")
                                 .segmentationUpidType(123)
                                 .segmentNum(123)
                                 .segmentsExpected(123)
                                 .subSegmentNum(123)
                                 .subSegmentsExpected(123)
                                 .build()))
                         .build())
                 .build()))
         .audienceMedia(List.of(AudienceMediaProperty.builder()
                 .alternateMedia(List.of(AlternateMediaProperty.builder()
                         .adBreaks(List.of(AdBreakProperty.builder()
                                 .offsetMillis(123)
                                 // the properties below are optional
                                 .adBreakMetadata(List.of(KeyValuePairProperty.builder()
                                         .key("key")
                                         .value("value")
                                         .build()))
                                 .messageType("messageType")
                                 .slate(SlateSourceProperty.builder()
                                         .sourceLocationName("sourceLocationName")
                                         .vodSourceName("vodSourceName")
                                         .build())
                                 .spliceInsertMessage(SpliceInsertMessageProperty.builder()
                                         .availNum(123)
                                         .availsExpected(123)
                                         .spliceEventId(123)
                                         .uniqueProgramId(123)
                                         .build())
                                 .timeSignalMessage(TimeSignalMessageProperty.builder()
                                         .segmentationDescriptors(List.of(SegmentationDescriptorProperty.builder()
                                                 .segmentationEventId(123)
                                                 .segmentationTypeId(123)
                                                 .segmentationUpid("segmentationUpid")
                                                 .segmentationUpidType(123)
                                                 .segmentNum(123)
                                                 .segmentsExpected(123)
                                                 .subSegmentNum(123)
                                                 .subSegmentsExpected(123)
                                                 .build()))
                                         .build())
                                 .build()))
                         .clipRange(ClipRangeProperty.builder()
                                 .endOffsetMillis(123)
                                 .startOffsetMillis(123)
                                 .build())
                         .durationMillis(123)
                         .liveSourceName("liveSourceName")
                         .scheduledStartTimeMillis(123)
                         .sourceLocationName("sourceLocationName")
                         .vodSourceName("vodSourceName")
                         .build()))
                 .audience("audience")
                 .build()))
         .liveSourceName("liveSourceName")
         .scheduleConfiguration(ScheduleConfigurationProperty.builder()
                 .transition(TransitionProperty.builder()
                         .relativePosition("relativePosition")
                         .type("type")
                         // the properties below are optional
                         .durationMillis(123)
                         .relativeProgram("relativeProgram")
                         .scheduledStartTimeMillis(123)
                         .build())
                 // the properties below are optional
                 .clipRange(ClipRangeProperty.builder()
                         .endOffsetMillis(123)
                         .startOffsetMillis(123)
                         .build())
                 .build())
         .vodSourceName("vodSourceName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnProgramProps.Builder	builder()
default Object	getAdBreaks()	The ad break configuration settings.
default Object	getAudienceMedia()	The list of AudienceMedia defined in program.
String	getChannelName()	The name of the channel for this Program.
default String	getLiveSourceName()	The name of the LiveSource for this Program.
String	getProgramName()	The name of the Program.
default Object	getScheduleConfiguration()	Schedule configuration parameters.
String	getSourceLocationName()	The name of the source location.
default String	getVodSourceName()	The name that's used to refer to a VOD source.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getChannelName

@Stability(Stable)
@NotNull
String getChannelName()

The name of the channel for this Program.

See Also:

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

getProgramName

@Stability(Stable)
@NotNull
String getProgramName()

The name of the Program.

See Also:

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

getSourceLocationName

@Stability(Stable)
@NotNull
String getSourceLocationName()

The name of the source location.

See Also:

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

getAdBreaks

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

The ad break configuration settings.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnProgram.AdBreakProperty>

See Also:

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

getAudienceMedia

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

The list of AudienceMedia defined in program.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnProgram.AudienceMediaProperty>

See Also:

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

getLiveSourceName

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

The name of the LiveSource for this Program.

See Also:

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

getScheduleConfiguration

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

Schedule configuration parameters.

Returns union: either IResolvable or CfnProgram.ScheduleConfigurationProperty

See Also:

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

getVodSourceName

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

The name that's used to refer to a VOD source.

See Also:

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

builder

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

Returns:

a CfnProgramProps.Builder of CfnProgramProps