Package software.amazon.awscdk.services.mediapackagev2

Interface CfnOriginEndpointProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnOriginEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:09.506Z")
@Stability(Stable)
public interface CfnOriginEndpointProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnOriginEndpoint.

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.mediapackagev2.*;
 CfnOriginEndpointProps cfnOriginEndpointProps = CfnOriginEndpointProps.builder()
         .channelGroupName("channelGroupName")
         .channelName("channelName")
         .containerType("containerType")
         .originEndpointName("originEndpointName")
         // the properties below are optional
         .dashManifests(List.of(DashManifestConfigurationProperty.builder()
                 .manifestName("manifestName")
                 // the properties below are optional
                 .baseUrls(List.of(DashBaseUrlProperty.builder()
                         .url("url")
                         // the properties below are optional
                         .dvbPriority(123)
                         .dvbWeight(123)
                         .serviceLocation("serviceLocation")
                         .build()))
                 .compactness("compactness")
                 .drmSignaling("drmSignaling")
                 .dvbSettings(DashDvbSettingsProperty.builder()
                         .errorMetrics(List.of(DashDvbMetricsReportingProperty.builder()
                                 .reportingUrl("reportingUrl")
                                 // the properties below are optional
                                 .probability(123)
                                 .build()))
                         .fontDownload(DashDvbFontDownloadProperty.builder()
                                 .fontFamily("fontFamily")
                                 .mimeType("mimeType")
                                 .url("url")
                                 .build())
                         .build())
                 .filterConfiguration(FilterConfigurationProperty.builder()
                         .clipStartTime("clipStartTime")
                         .end("end")
                         .manifestFilter("manifestFilter")
                         .start("start")
                         .timeDelaySeconds(123)
                         .build())
                 .manifestWindowSeconds(123)
                 .minBufferTimeSeconds(123)
                 .minUpdatePeriodSeconds(123)
                 .periodTriggers(List.of("periodTriggers"))
                 .profiles(List.of("profiles"))
                 .programInformation(DashProgramInformationProperty.builder()
                         .copyright("copyright")
                         .languageCode("languageCode")
                         .moreInformationUrl("moreInformationUrl")
                         .source("source")
                         .title("title")
                         .build())
                 .scteDash(ScteDashProperty.builder()
                         .adMarkerDash("adMarkerDash")
                         .build())
                 .segmentTemplateFormat("segmentTemplateFormat")
                 .subtitleConfiguration(DashSubtitleConfigurationProperty.builder()
                         .ttmlConfiguration(DashTtmlConfigurationProperty.builder()
                                 .ttmlProfile("ttmlProfile")
                                 .build())
                         .build())
                 .suggestedPresentationDelaySeconds(123)
                 .utcTiming(DashUtcTimingProperty.builder()
                         .timingMode("timingMode")
                         .timingSource("timingSource")
                         .build())
                 .build()))
         .description("description")
         .forceEndpointErrorConfiguration(ForceEndpointErrorConfigurationProperty.builder()
                 .endpointErrorConditions(List.of("endpointErrorConditions"))
                 .build())
         .hlsManifests(List.of(HlsManifestConfigurationProperty.builder()
                 .manifestName("manifestName")
                 // the properties below are optional
                 .childManifestName("childManifestName")
                 .filterConfiguration(FilterConfigurationProperty.builder()
                         .clipStartTime("clipStartTime")
                         .end("end")
                         .manifestFilter("manifestFilter")
                         .start("start")
                         .timeDelaySeconds(123)
                         .build())
                 .manifestWindowSeconds(123)
                 .programDateTimeIntervalSeconds(123)
                 .scteHls(ScteHlsProperty.builder()
                         .adMarkerHls("adMarkerHls")
                         .build())
                 .startTag(StartTagProperty.builder()
                         .timeOffset(123)
                         // the properties below are optional
                         .precise(false)
                         .build())
                 .url("url")
                 .urlEncodeChildManifest(false)
                 .build()))
         .lowLatencyHlsManifests(List.of(LowLatencyHlsManifestConfigurationProperty.builder()
                 .manifestName("manifestName")
                 // the properties below are optional
                 .childManifestName("childManifestName")
                 .filterConfiguration(FilterConfigurationProperty.builder()
                         .clipStartTime("clipStartTime")
                         .end("end")
                         .manifestFilter("manifestFilter")
                         .start("start")
                         .timeDelaySeconds(123)
                         .build())
                 .manifestWindowSeconds(123)
                 .programDateTimeIntervalSeconds(123)
                 .scteHls(ScteHlsProperty.builder()
                         .adMarkerHls("adMarkerHls")
                         .build())
                 .startTag(StartTagProperty.builder()
                         .timeOffset(123)
                         // the properties below are optional
                         .precise(false)
                         .build())
                 .url("url")
                 .urlEncodeChildManifest(false)
                 .build()))
         .mssManifests(List.of(MssManifestConfigurationProperty.builder()
                 .manifestName("manifestName")
                 // the properties below are optional
                 .filterConfiguration(FilterConfigurationProperty.builder()
                         .clipStartTime("clipStartTime")
                         .end("end")
                         .manifestFilter("manifestFilter")
                         .start("start")
                         .timeDelaySeconds(123)
                         .build())
                 .manifestLayout("manifestLayout")
                 .manifestWindowSeconds(123)
                 .build()))
         .segment(SegmentProperty.builder()
                 .encryption(EncryptionProperty.builder()
                         .encryptionMethod(EncryptionMethodProperty.builder()
                                 .cmafEncryptionMethod("cmafEncryptionMethod")
                                 .ismEncryptionMethod("ismEncryptionMethod")
                                 .tsEncryptionMethod("tsEncryptionMethod")
                                 .build())
                         .spekeKeyProvider(SpekeKeyProviderProperty.builder()
                                 .drmSystems(List.of("drmSystems"))
                                 .encryptionContractConfiguration(EncryptionContractConfigurationProperty.builder()
                                         .presetSpeke20Audio("presetSpeke20Audio")
                                         .presetSpeke20Video("presetSpeke20Video")
                                         .build())
                                 .resourceId("resourceId")
                                 .roleArn("roleArn")
                                 .url("url")
                                 .build())
                         // the properties below are optional
                         .cmafExcludeSegmentDrmMetadata(false)
                         .constantInitializationVector("constantInitializationVector")
                         .keyRotationIntervalSeconds(123)
                         .build())
                 .includeIframeOnlyStreams(false)
                 .scte(ScteProperty.builder()
                         .scteFilter(List.of("scteFilter"))
                         .build())
                 .segmentDurationSeconds(123)
                 .segmentName("segmentName")
                 .tsIncludeDvbSubtitles(false)
                 .tsUseAudioRenditionGroup(false)
                 .build())
         .startoverWindowSeconds(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnOriginEndpointProps.Builder	A builder for CfnOriginEndpointProps
static final class	CfnOriginEndpointProps.Jsii$Proxy	An implementation for CfnOriginEndpointProps

Method Summary

Modifier and Type	Method	Description
static CfnOriginEndpointProps.Builder	builder()
String	getChannelGroupName()	The name of the channel group associated with the origin endpoint configuration.
String	getChannelName()	The channel name associated with the origin endpoint.
String	getContainerType()	The container type associated with the origin endpoint configuration.
default Object	getDashManifests()	A DASH manifest configuration.
default String	getDescription()	The description associated with the origin endpoint.
default Object	getForceEndpointErrorConfiguration()	The failover settings for the endpoint.
default Object	getHlsManifests()	The HLS manifests associated with the origin endpoint configuration.
default Object	getLowLatencyHlsManifests()	The low-latency HLS (LL-HLS) manifests associated with the origin endpoint.
default Object	getMssManifests()	A list of Microsoft Smooth Streaming (MSS) manifest configurations associated with the origin endpoint.
String	getOriginEndpointName()	The name of the origin endpoint associated with the origin endpoint configuration.
default Object	getSegment()	The segment associated with the origin endpoint.
default Number	getStartoverWindowSeconds()	The size of the window (in seconds) to specify a window of the live stream that's available for on-demand viewing.
default List<CfnTag>	getTags()	The tags associated with the origin endpoint.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getChannelGroupName

@Stability(Stable)
@NotNull
String getChannelGroupName()

The name of the channel group associated with the origin endpoint configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-channelgroupname

getChannelName

@Stability(Stable)
@NotNull
String getChannelName()

The channel name associated with the origin endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-channelname

getContainerType

@Stability(Stable)
@NotNull
String getContainerType()

The container type associated with the origin endpoint configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-containertype

getOriginEndpointName

@Stability(Stable)
@NotNull
String getOriginEndpointName()

The name of the origin endpoint associated with the origin endpoint configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-originendpointname

getDashManifests

@Stability(Stable)
@Nullable
default Object getDashManifests()

A DASH manifest configuration.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnOriginEndpoint.DashManifestConfigurationProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-dashmanifests

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description associated with the origin endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-description

getForceEndpointErrorConfiguration

@Stability(Stable)
@Nullable
default Object getForceEndpointErrorConfiguration()

The failover settings for the endpoint.

Returns union: either IResolvable or CfnOriginEndpoint.ForceEndpointErrorConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-forceendpointerrorconfiguration

getHlsManifests

@Stability(Stable)
@Nullable
default Object getHlsManifests()

The HLS manifests associated with the origin endpoint configuration.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnOriginEndpoint.HlsManifestConfigurationProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-hlsmanifests

getLowLatencyHlsManifests

@Stability(Stable)
@Nullable
default Object getLowLatencyHlsManifests()

The low-latency HLS (LL-HLS) manifests associated with the origin endpoint.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnOriginEndpoint.LowLatencyHlsManifestConfigurationProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifests

getMssManifests

@Stability(Stable)
@Nullable
default Object getMssManifests()

A list of Microsoft Smooth Streaming (MSS) manifest configurations associated with the origin endpoint.

Each configuration represents a different MSS streaming option available from this endpoint.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnOriginEndpoint.MssManifestConfigurationProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-mssmanifests

getSegment

@Stability(Stable)
@Nullable
default Object getSegment()

The segment associated with the origin endpoint.

Returns union: either IResolvable or CfnOriginEndpoint.SegmentProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-segment

getStartoverWindowSeconds

@Stability(Stable)
@Nullable
default Number getStartoverWindowSeconds()

The size of the window (in seconds) to specify a window of the live stream that's available for on-demand viewing.

Viewers can start-over or catch-up on content that falls within the window.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-startoverwindowseconds

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags associated with the origin endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-tags

builder

@Stability(Stable)
static CfnOriginEndpointProps.Builder builder()

Returns:

a CfnOriginEndpointProps.Builder of CfnOriginEndpointProps