Package software.amazon.awscdk.services.mediatailor

Class CfnProgram

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.mediatailor.CfnProgram

All Implemented Interfaces:

IInspectable, IEnvironmentAware, IProgramRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-10-08T16:59:58.883Z")
@Stability(Stable)
public class CfnProgram
extends CfnResource
implements IInspectable, IProgramRef

Resource schema for AWS::MediaTailor::Program.

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.*;
 CfnProgram cfnProgram = CfnProgram.Builder.create(this, "MyCfnProgram")
         .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	Class	Description
static interface	CfnProgram.AdBreakProperty	Ad break configuration parameters.
static interface	CfnProgram.AlternateMediaProperty	A playlist of media to be played instead of the default media on a particular program.
static interface	CfnProgram.AudienceMediaProperty	An AudienceMedia object contains an Audience and a list of AlternateMedia.
static final class	CfnProgram.Builder	A fluent builder for CfnProgram.
static interface	CfnProgram.ClipRangeProperty	Clip range configuration for the VOD source associated with the program.
static interface	CfnProgram.KeyValuePairProperty	For SCTE35_ENHANCED output, defines a key and corresponding value.
static interface	CfnProgram.ScheduleConfigurationProperty	Schedule configuration parameters.
static interface	CfnProgram.SegmentationDescriptorProperty	The segmentation_descriptor message configuration.
static interface	CfnProgram.SlateSourceProperty	Slate VOD source configuration.
static interface	CfnProgram.SpliceInsertMessageProperty	Splice insert message configuration.
static interface	CfnProgram.TimeSignalMessageProperty	The SCTE-35 time_signal message configuration.
static interface	CfnProgram.TransitionProperty	Program transition configuration.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.mediatailor.IProgramRef

IProgramRef.Jsii$Default, IProgramRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnProgram(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnProgram(software.amazon.jsii.JsiiObjectRef objRef)
	CfnProgram(software.constructs.Construct scope, String id, CfnProgramProps props)	Create a new AWS::MediaTailor::Program.

Method Summary

Modifier and Type	Method	Description
static String	arnForProgram(IProgramRef resource)
Object	getAdBreaks()	The ad break configuration settings.
String	getAttrArn()	The ARN of the program.
IResolvable	getAttrClipRange()	Clip range configuration for the VOD source associated with the program.
String	getAttrCreationTime()	The timestamp of when the program was created.
Number	getAttrDurationMillis()	The duration of the live program in milliseconds.
String	getAttrScheduledStartTime()	The date and time that the program is scheduled to start.
Object	getAudienceMedia()	The list of AudienceMedia defined in program.
protected Map<String,Object>	getCfnProperties()
protected Map<String,String>	getCfnPropertyNames()
String	getChannelName()	The name of the channel for this Program.
String	getLiveSourceName()	The name of the LiveSource for this Program.
String	getProgramName()	The name of the Program.
ProgramReference	getProgramRef()	A reference to a Program resource.
Object	getScheduleConfiguration()	Schedule configuration parameters.
String	getSourceLocationName()	The name of the source location.
String	getVodSourceName()	The name that's used to refer to a VOD source.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnProgram(Object x)	Checks whether the given object is a CfnProgram.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAdBreaks(List<Object> value)	The ad break configuration settings.
void	setAdBreaks(IResolvable value)	The ad break configuration settings.
void	setAudienceMedia(List<Object> value)	The list of AudienceMedia defined in program.
void	setAudienceMedia(IResolvable value)	The list of AudienceMedia defined in program.
void	setChannelName(String value)	The name of the channel for this Program.
void	setLiveSourceName(String value)	The name of the LiveSource for this Program.
void	setProgramName(String value)	The name of the Program.
void	setScheduleConfiguration(IResolvable value)	Schedule configuration parameters.
void	setScheduleConfiguration(CfnProgram.ScheduleConfigurationProperty value)	Schedule configuration parameters.
void	setSourceLocationName(String value)	The name of the source location.
void	setVodSourceName(String value)	The name that's used to refer to a VOD source.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, addResourceDependency, addResourceDependency, applyCrossStackReferenceStrength, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, cfnPropertyName, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, removeDependency, removeResourceDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId, with

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnProgram

protected CfnProgram(software.amazon.jsii.JsiiObjectRef objRef)

CfnProgram

protected CfnProgram(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnProgram

@Stability(Stable)
public CfnProgram(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnProgramProps props)

Create a new AWS::MediaTailor::Program.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

arnForProgram

@Stability(Stable)
@NotNull
public static String arnForProgram(@NotNull
 IProgramRef resource)

Parameters:

resource - This parameter is required.

isCfnProgram

@Stability(Stable)
@NotNull
public static Boolean isCfnProgram(@NotNull
 Object x)

Checks whether the given object is a CfnProgram.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The ARN of the program.

getAttrClipRange

@Stability(Stable)
@NotNull
public IResolvable getAttrClipRange()

Clip range configuration for the VOD source associated with the program.

getAttrCreationTime

@Stability(Stable)
@NotNull
public String getAttrCreationTime()

The timestamp of when the program was created.

getAttrDurationMillis

@Stability(Stable)
@NotNull
public Number getAttrDurationMillis()

The duration of the live program in milliseconds.

getAttrScheduledStartTime

@Stability(Stable)
@NotNull
public String getAttrScheduledStartTime()

The date and time that the program is scheduled to start.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCfnPropertyNames

@Stability(Stable)
@NotNull
protected Map<String,String> getCfnPropertyNames()

Overrides:

getCfnPropertyNames in class CfnResource

getProgramRef

@Stability(Stable)
@NotNull
public ProgramReference getProgramRef()

A reference to a Program resource.

Specified by:

getProgramRef in interface IProgramRef

getChannelName

@Stability(Stable)
@NotNull
public String getChannelName()

The name of the channel for this Program.

setChannelName

@Stability(Stable)
public void setChannelName(@NotNull
 String value)

The name of the channel for this Program.

getProgramName

@Stability(Stable)
@NotNull
public String getProgramName()

The name of the Program.

setProgramName

@Stability(Stable)
public void setProgramName(@NotNull
 String value)

The name of the Program.

getSourceLocationName

@Stability(Stable)
@NotNull
public String getSourceLocationName()

The name of the source location.

setSourceLocationName

@Stability(Stable)
public void setSourceLocationName(@NotNull
 String value)

The name of the source location.

getAdBreaks

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

The ad break configuration settings.

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

setAdBreaks

@Stability(Stable)
public void setAdBreaks(@Nullable
 IResolvable value)

The ad break configuration settings.

setAdBreaks

@Stability(Stable)
public void setAdBreaks(@Nullable
 List<Object> value)

The ad break configuration settings.

getAudienceMedia

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

The list of AudienceMedia defined in program.

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

setAudienceMedia

@Stability(Stable)
public void setAudienceMedia(@Nullable
 IResolvable value)

The list of AudienceMedia defined in program.

setAudienceMedia

@Stability(Stable)
public void setAudienceMedia(@Nullable
 List<Object> value)

The list of AudienceMedia defined in program.

getLiveSourceName

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

The name of the LiveSource for this Program.

setLiveSourceName

@Stability(Stable)
public void setLiveSourceName(@Nullable
 String value)

The name of the LiveSource for this Program.

getScheduleConfiguration

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

Schedule configuration parameters.

Returns union: either IResolvable or CfnProgram.ScheduleConfigurationProperty

setScheduleConfiguration

@Stability(Stable)
public void setScheduleConfiguration(@Nullable
 IResolvable value)

Schedule configuration parameters.

setScheduleConfiguration

@Stability(Stable)
public void setScheduleConfiguration(@Nullable
 CfnProgram.ScheduleConfigurationProperty value)

Schedule configuration parameters.

getVodSourceName

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

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

setVodSourceName

@Stability(Stable)
public void setVodSourceName(@Nullable
 String value)

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