interface OriginEndpointProps 🔹

Language	Type name
.NET	Amazon.CDK.AWS.MediaPackageV2.Alpha.OriginEndpointProps
Go	github.com/aws/aws-cdk-go/awsmediapackagev2alpha/v2#OriginEndpointProps
Java	software.amazon.awscdk.services.mediapackagev2.alpha.OriginEndpointProps
Python	aws_cdk.aws_mediapackagev2_alpha.OriginEndpointProps
TypeScript (source)	@aws-cdk/aws-mediapackagev2-alpha » OriginEndpointProps

Implements OriginEndpointOptions

Properties to set on an Origin Endpoint.

Example

declare const channel: Channel;
declare const spekeRole: iam.IRole;

new OriginEndpoint(this, 'TsEndpoint', {
  channel,
  segment: Segment.ts({
    encryption: TsEncryption.speke({
      method: TsEncryptionMethod.SAMPLE_AES,
      resourceId: 'my-content-id',
      url: 'https://example.com/speke',
      role: spekeRole,
    }),
  }),
  manifests: [Manifest.hls({ manifestName: 'index' })],
});

Properties

Name	Type	Description
channel🔹	IChannel	The channel associated with the origin endpoint.
manifests🔹	Manifest[]	Manifests configuration for HLS, Low Latency HLS and DASH.
segment🔹	SegmentConfiguration	The segment associated with the origin endpoint.
cdnAuth?🔹	CdnAuthConfiguration	Provide access to MediaPackage V2 Origin Endpoint via secret header.
description?🔹	string	The description associated with the origin endpoint.
forceEndpointConfigurationConditions?🔹	EndpointErrorConfiguration[]	The failover settings for the endpoint.
originEndpointName?🔹	string	The name of the origin endpoint associated with the origin endpoint configuration.
removalPolicy?🔹	RemovalPolicy	Policy to apply when the origin endpoint is removed from the stack.
startoverWindow?🔹	Duration	The 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.

---

channel🔹

Type: IChannel

The channel 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.