Skip to content
v2.275.0

CfnProgramProps Struct ​

Properties for defining a CfnProgram.

Example ​

ts
// 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 cfnProgramProps: mediatailor.CfnProgramProps = {
  channelName: 'channelName',
  programName: 'programName',
  sourceLocationName: 'sourceLocationName',

  // the properties below are optional
  adBreaks: [{
    offsetMillis: 123,

    // the properties below are optional
    adBreakMetadata: [{
      key: 'key',
      value: 'value',
    }],
    messageType: 'messageType',
    slate: {
      sourceLocationName: 'sourceLocationName',
      vodSourceName: 'vodSourceName',
    },
    spliceInsertMessage: {
      availNum: 123,
      availsExpected: 123,
      spliceEventId: 123,
      uniqueProgramId: 123,
    },
    timeSignalMessage: {
      segmentationDescriptors: [{
        segmentationEventId: 123,
        segmentationTypeId: 123,
        segmentationUpid: 'segmentationUpid',
        segmentationUpidType: 123,
        segmentNum: 123,
        segmentsExpected: 123,
        subSegmentNum: 123,
        subSegmentsExpected: 123,
      }],
    },
  }],
  audienceMedia: [{
    alternateMedia: [{
      adBreaks: [{
        offsetMillis: 123,

        // the properties below are optional
        adBreakMetadata: [{
          key: 'key',
          value: 'value',
        }],
        messageType: 'messageType',
        slate: {
          sourceLocationName: 'sourceLocationName',
          vodSourceName: 'vodSourceName',
        },
        spliceInsertMessage: {
          availNum: 123,
          availsExpected: 123,
          spliceEventId: 123,
          uniqueProgramId: 123,
        },
        timeSignalMessage: {
          segmentationDescriptors: [{
            segmentationEventId: 123,
            segmentationTypeId: 123,
            segmentationUpid: 'segmentationUpid',
            segmentationUpidType: 123,
            segmentNum: 123,
            segmentsExpected: 123,
            subSegmentNum: 123,
            subSegmentsExpected: 123,
          }],
        },
      }],
      clipRange: {
        endOffsetMillis: 123,
        startOffsetMillis: 123,
      },
      durationMillis: 123,
      liveSourceName: 'liveSourceName',
      scheduledStartTimeMillis: 123,
      sourceLocationName: 'sourceLocationName',
      vodSourceName: 'vodSourceName',
    }],
    audience: 'audience',
  }],
  liveSourceName: 'liveSourceName',
  scheduleConfiguration: {
    transition: {
      relativePosition: 'relativePosition',
      type: 'type',

      // the properties below are optional
      durationMillis: 123,
      relativeProgram: 'relativeProgram',
      scheduledStartTimeMillis: 123,
    },

    // the properties below are optional
    clipRange: {
      endOffsetMillis: 123,
      startOffsetMillis: 123,
    },
  },
  vodSourceName: 'vodSourceName',
};

Properties ​

adBreaksoptionalIResolvable | IResolvable | CfnProgram.AdBreakProperty[]ad_breaksoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AdBreakProperty]]]adBreaksoptionalIResolvableAdBreaksoptionalIResolvableAdBreaksoptionalinterface{}#
The ad break configuration settings.
audienceMediaoptionalIResolvable | IResolvable | CfnProgram.AudienceMediaProperty[]audience_mediaoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AudienceMediaProperty]]]audienceMediaoptionalIResolvableAudienceMediaoptionalIResolvableAudienceMediaoptionalinterface{}#
The list of AudienceMedia defined in program.
channelNamestringchannel_namestrchannelNameStringChannelNamestringChannelName*stringrequired#
The name of the channel for this Program.
liveSourceNameoptionalstringlive_source_nameoptionalstrliveSourceNameoptionalStringLiveSourceNameoptionalstringLiveSourceNameoptional*string#
The name of the LiveSource for this Program.
programNamestringprogram_namestrprogramNameStringProgramNamestringProgramName*stringrequired#
The name of the Program.
scheduleConfigurationoptionalIResolvable | CfnProgram.ScheduleConfigurationPropertyschedule_configurationoptionaltyping.Union[IResolvable, ScheduleConfigurationProperty]scheduleConfigurationoptionalIResolvableScheduleConfigurationoptionalIResolvableScheduleConfigurationoptionalinterface{}#
Schedule configuration parameters.
sourceLocationNamestringsource_location_namestrsourceLocationNameStringSourceLocationNamestringSourceLocationName*stringrequired#
The name of the source location.
vodSourceNameoptionalstringvod_source_nameoptionalstrvodSourceNameoptionalStringVodSourceNameoptionalstringVodSourceNameoptional*string#
The name that's used to refer to a VOD source.