View a markdown version of this page

AWS::MediaTailor::Program SegmentationDescriptor - AWS CloudFormation
SyntaxProperties

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::MediaTailor::Program SegmentationDescriptor

The segmentation_descriptor message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of the EXT-X-DATERANGE or EventStream ad marker's SCTE-35 data.

segmentation_descriptor messages must be sent with the time_signal message type.

See the segmentation_descriptor() table of the 2022 SCTE-35 specification for more information.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "SegmentationEventId" : Integer,
  "SegmentationTypeId" : Integer,
  "SegmentationUpid" : String,
  "SegmentationUpidType" : Integer,
  "SegmentNum" : Integer,
  "SegmentsExpected" : Integer,
  "SubSegmentNum" : Integer,
  "SubSegmentsExpected" : Integer
}

Properties

SegmentationEventId

The Event Identifier to assign to the segmentation_descriptor.segmentation_event_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.

Required: No

Type: Integer

Update requires: No interruption

SegmentationTypeId

The Type Identifier to assign to the segmentation_descriptor.segmentation_type_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.

Required: No

Type: Integer

Update requires: No interruption

SegmentationUpid

The Upid to assign to the segmentation_descriptor.segmentation_upid message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is "" (an empty string).

Required: No

Type: String

Update requires: No interruption

SegmentationUpidType

The Upid Type to assign to the segmentation_descriptor.segmentation_upid_type message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.

Required: No

Type: Integer

Update requires: No interruption

SegmentNum

The segment number to assign to the segmentation_descriptor.segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.

Required: No

Type: Integer

Update requires: No interruption

SegmentsExpected

The number of segments expected, which is assigned to the segmentation_descriptor.segments_expectedS message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.

Required: No

Type: Integer

Update requires: No interruption

SubSegmentNum

The sub-segment number to assign to the segmentation_descriptor.sub_segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.

Required: No

Type: Integer

Update requires: No interruption

SubSegmentsExpected

The number of sub-segments expected, which is assigned to the segmentation_descriptor.sub_segments_expected message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.

Required: No

Type: Integer

Update requires: No interruption