interface AdBreakProperty

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

Ad break configuration parameters.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-adbreak.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 adBreakProperty: mediatailor.CfnProgram.AdBreakProperty = {
  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,
    }],
  },
};

Properties

Name	Type	Description
offsetMillis	number	How long (in milliseconds) after the beginning of the program that an ad starts.
adBreakMetadata?	IResolvable | (IResolvable | KeyValuePairProperty)[]	Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSET tag for SCTE35_ENHANCED output.
messageType?	string	The SCTE-35 ad insertion type.
slate?	IResolvable | SlateSourceProperty	Slate VOD source configuration.
spliceInsertMessage?	IResolvable | SpliceInsertMessageProperty	Splice insert message configuration.
timeSignalMessage?	IResolvable | TimeSignalMessageProperty	The SCTE-35 time_signal message configuration.

---

offsetMillis

Type: number

How long (in milliseconds) after the beginning of the program that an ad starts.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-adbreak.html#cfn-mediatailor-program-adbreak-offsetmillis

---

adBreakMetadata?

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

Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSET tag for SCTE35_ENHANCED output.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-adbreak.html#cfn-mediatailor-program-adbreak-adbreakmetadata

---

messageType?

Type: string (optional)

The SCTE-35 ad insertion type.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-adbreak.html#cfn-mediatailor-program-adbreak-messagetype

---

slate?

Type: IResolvable | SlateSourceProperty (optional)

Slate VOD source configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-adbreak.html#cfn-mediatailor-program-adbreak-slate

---

spliceInsertMessage?

Type: IResolvable | SpliceInsertMessageProperty (optional)

Splice insert message configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-adbreak.html#cfn-mediatailor-program-adbreak-spliceinsertmessage

---

timeSignalMessage?

Type: IResolvable | TimeSignalMessageProperty (optional)

The SCTE-35 time_signal message configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mediatailor-program-adbreak.html#cfn-mediatailor-program-adbreak-timesignalmessage