interface CfnProgramProps

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

Properties for defining a CfnProgram.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-program.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 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

Name	Type	Description
channelName	string	The name of the channel for this Program.
programName	string	The name of the Program.
sourceLocationName	string	The name of the source location.
adBreaks?	IResolvable | (IResolvable | AdBreakProperty)[]	The ad break configuration settings.
audienceMedia?	IResolvable | (IResolvable | AudienceMediaProperty)[]	The list of AudienceMedia defined in program.
liveSourceName?	string	The name of the LiveSource for this Program.
scheduleConfiguration?	IResolvable | ScheduleConfigurationProperty	Schedule configuration parameters.
vodSourceName?	string	The name that's used to refer to a VOD source.

---

channelName

Type: string

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

---

programName

Type: string

The name of the Program.

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

---

sourceLocationName

Type: string

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

---

adBreaks?

Type: IResolvable | (IResolvable | AdBreakProperty)[] (optional)

The ad break configuration settings.

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

---

audienceMedia?

Type: IResolvable | (IResolvable | AudienceMediaProperty)[] (optional)

The list of AudienceMedia defined in program.

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

---

liveSourceName?

Type: string (optional)

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

---

scheduleConfiguration?

Type: IResolvable | ScheduleConfigurationProperty (optional)

Schedule configuration parameters.

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

---

vodSourceName?

Type: string (optional)

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