2.248.0

interface OriginEndpointOptions 🔹

LanguageType name
.NETAmazon.CDK.AWS.MediaPackageV2.Alpha.OriginEndpointOptions
Gogithub.com/aws/aws-cdk-go/awsmediapackagev2alpha/v2#OriginEndpointOptions
Javasoftware.amazon.awscdk.services.mediapackagev2.alpha.OriginEndpointOptions
Pythonaws_cdk.aws_mediapackagev2_alpha.OriginEndpointOptions
TypeScript (source)@aws-cdk/aws-mediapackagev2-alpha » OriginEndpointOptions

Configuration parameters for an AWS Elemental MediaPackage V2 Origin Endpoint.

Example

declare const stack: Stack;

// Create a channel group
const group = new ChannelGroup(stack, 'MyChannelGroup', {
  channelGroupName: 'my-channel-group',
});

// Add a channel using the factory method
const channel = group.addChannel('MyChannel', {
  channelName: 'my-channel',
  input: InputConfiguration.cmaf(),
});

// Add an origin endpoint using the factory method
const endpoint = channel.addOriginEndpoint('MyEndpoint', {
  originEndpointName: 'my-endpoint',
  segment: Segment.cmaf(),
  manifests: [Manifest.hls({ manifestName: 'index' })],
});

Properties

NameTypeDescription
manifests🔹Manifest[]Manifests configuration for HLS, Low Latency HLS and DASH.
segment🔹SegmentConfigurationThe segment associated with the origin endpoint.
cdnAuth?🔹CdnAuthConfigurationProvide access to MediaPackage V2 Origin Endpoint via secret header.
description?🔹stringThe description associated with the origin endpoint.
forceEndpointConfigurationConditions?🔹EndpointErrorConfiguration[]The failover settings for the endpoint.
originEndpointName?🔹stringThe name of the origin endpoint associated with the origin endpoint configuration.
removalPolicy?🔹RemovalPolicyPolicy to apply when the origin endpoint is removed from the stack.
startoverWindow?🔹DurationThe size of the window to specify a window of the live stream that's available for on-demand viewing.
tags?🔹{ [string]: string }The tags associated with the origin endpoint.

manifests🔹

Type: Manifest[]

Manifests configuration for HLS, Low Latency HLS and DASH.

segment🔹

Type: SegmentConfiguration

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.

cdnAuth?🔹

Type: CdnAuthConfiguration (optional, default: undefined - Not configured on endpoint)

Provide access to MediaPackage V2 Origin Endpoint via secret header.

description?🔹

Type: string (optional, default: undefined - No description is added to Origin Endpoint)

The description associated with the origin endpoint.

forceEndpointConfigurationConditions?🔹

Type: EndpointErrorConfiguration[] (optional, default: undefined - No force endpoint configuration is configured)

The failover settings for the endpoint.

originEndpointName?🔹

Type: string (optional, default: autogenerated)

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

removalPolicy?🔹

Type: RemovalPolicy (optional, default: RemovalPolicy.DESTROY)

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.

startoverWindow?🔹

Type: Duration (optional, default: 900)

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.

tags?🔹

Type: { [string]: string } (optional, default: No tagging)

The tags associated with the origin endpoint.

← PreviousNext →