Package software.amazon.awscdk.services.mediapackagev2.alpha

Interface OriginEndpointOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

OriginEndpointProps

All Known Implementing Classes:

OriginEndpointOptions.Jsii$Proxy, OriginEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-02T09:32:03.726Z")
@Stability(Experimental)
public interface OriginEndpointOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Configuration parameters for an AWS Elemental MediaPackage V2 Origin Endpoint.

Example:

 Stack stack;
 // Create a channel group
 ChannelGroup group = ChannelGroup.Builder.create(stack, "MyChannelGroup")
         .channelGroupName("my-channel-group")
         .build();
 // Add a channel using the factory method
 Channel channel = group.addChannel("MyChannel", ChannelOptions.builder()
         .channelName("my-channel")
         .input(InputConfiguration.cmaf())
         .build());
 // Add an origin endpoint using the factory method
 OriginEndpoint endpoint = channel.addOriginEndpoint("MyEndpoint", OriginEndpointOptions.builder()
         .originEndpointName("my-endpoint")
         .segment(Segment.cmaf())
         .manifests(List.of(Manifest.hls(HlsManifestConfiguration.builder().manifestName("index").build())))
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static OriginEndpointOptions.Builder	builder()
default CdnAuthConfiguration	getCdnAuth()	(experimental) Provide access to MediaPackage V2 Origin Endpoint via secret header.
default String	getDescription()	(experimental) The description associated with the origin endpoint.
default List<EndpointErrorConfiguration>	getForceEndpointConfigurationConditions()	(experimental) The failover settings for the endpoint.
List<Manifest>	getManifests()	(experimental) Manifests configuration for HLS, Low Latency HLS and DASH.
default String	getOriginEndpointName()	(experimental) The name of the origin endpoint associated with the origin endpoint configuration.
default RemovalPolicy	getRemovalPolicy()	(experimental) Policy to apply when the origin endpoint is removed from the stack.
SegmentConfiguration	getSegment()	(experimental) The segment associated with the origin endpoint.
default Duration	getStartoverWindow()	(experimental) The size of the window to specify a window of the live stream that's available for on-demand viewing.
default Map<String,String>	getTags()	(experimental) The tags associated with the origin endpoint.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getManifests

@Stability(Experimental)
@NotNull
List<Manifest> getManifests()

(experimental) Manifests configuration for HLS, Low Latency HLS and DASH.

getSegment

@Stability(Experimental)
@NotNull
SegmentConfiguration getSegment()

(experimental) The segment associated with the origin endpoint.

Inside the segment configuration you can define options such as encryption, SPEKE parameters and other general segment configurations.

Use Segment.ts() or Segment.cmaf() to create the configuration.

getCdnAuth

@Stability(Experimental)
@Nullable
default CdnAuthConfiguration getCdnAuth()

(experimental) Provide access to MediaPackage V2 Origin Endpoint via secret header.

Default: undefined - Not configured on endpoint

getDescription

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

(experimental) The description associated with the origin endpoint.

Default: undefined - No description is added to Origin Endpoint

getForceEndpointConfigurationConditions

@Stability(Experimental)
@Nullable
default List<EndpointErrorConfiguration> getForceEndpointConfigurationConditions()

(experimental) The failover settings for the endpoint.

Default: undefined - No force endpoint configuration is configured

getOriginEndpointName

@Stability(Experimental)
@Nullable
default String getOriginEndpointName()

(experimental) The name of the origin endpoint associated with the origin endpoint configuration.

Default: autogenerated

getRemovalPolicy

@Stability(Experimental)
@Nullable
default RemovalPolicy getRemovalPolicy()

(experimental) Policy to apply when the origin endpoint is removed from the stack.

Even though MediaPackage ChannelGroups, Channels and OriginEndpoints are technically stateful, their contents are transient and it is common to add and remove these while rearchitecting your application. The default is therefore DESTROY. Change it to RETAIN if the content (in a lookback window) are so valuable that accidentally losing it would be unacceptable.

Default: RemovalPolicy.DESTROY

getStartoverWindow

@Stability(Experimental)
@Nullable
default Duration getStartoverWindow()

(experimental) The size of the window 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.

Default: 900

getTags

@Stability(Experimental)
@Nullable
default Map<String,String> getTags()

(experimental) The tags associated with the origin endpoint.

Default: - No tagging

builder

@Stability(Experimental)
static OriginEndpointOptions.Builder builder()

Returns:

a OriginEndpointOptions.Builder of OriginEndpointOptions