OriginEndpointOptions

class aws_cdk.aws_mediapackagev2_alpha.OriginEndpointOptions(*, manifests, segment, cdn_auth=None, description=None, force_endpoint_configuration_conditions=None, origin_endpoint_name=None, removal_policy=None, startover_window=None, tags=None)

Bases: object

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

Parameters:

manifests (Sequence[Manifest]) – (experimental) Manifests configuration for HLS, Low Latency HLS and DASH.
segment (Union[SegmentConfiguration, Dict[str, Any]]) – (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.
cdn_auth (Union[CdnAuthConfiguration, Dict[str, Any], None]) – (experimental) Provide access to MediaPackage V2 Origin Endpoint via secret header. Default: undefined - Not configured on endpoint
description (Optional[str]) – (experimental) The description associated with the origin endpoint. Default: undefined - No description is added to Origin Endpoint
force_endpoint_configuration_conditions (Optional[Sequence[EndpointErrorConfiguration]]) – (experimental) The failover settings for the endpoint. Default: undefined - No force endpoint configuration is configured
origin_endpoint_name (Optional[str]) – (experimental) The name of the origin endpoint associated with the origin endpoint configuration. Default: autogenerated
removal_policy (Optional[RemovalPolicy]) – (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
startover_window (Optional[Duration]) – (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
tags (Optional[Mapping[str, str]]) – (experimental) The tags associated with the origin endpoint. Default: - No tagging

Stability:

experimental

ExampleMetadata:

infused

Example:

# stack: Stack


# Create a channel group
group = ChannelGroup(stack, "MyChannelGroup",
    channel_group_name="my-channel-group"
)

# Add a channel using the factory method
channel = group.add_channel("MyChannel",
    channel_name="my-channel",
    input=InputConfiguration.cmaf()
)

# Add an origin endpoint using the factory method
endpoint = channel.add_origin_endpoint("MyEndpoint",
    origin_endpoint_name="my-endpoint",
    segment=Segment.cmaf(),
    manifests=[Manifest.hls(manifest_name="index")]
)

Attributes

cdn_auth

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

Default:: undefined - Not configured on endpoint
Stability:: experimental

description

(experimental) The description associated with the origin endpoint.

Default:: undefined - No description is added to Origin Endpoint
Stability:: experimental

force_endpoint_configuration_conditions

(experimental) The failover settings for the endpoint.

Default:: undefined - No force endpoint configuration is configured
Stability:: experimental

manifests

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

Stability:: experimental

origin_endpoint_name

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

Default:: autogenerated
Stability:: experimental

removal_policy

(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
Stability:: experimental

segment

(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.

Stability:: experimental

startover_window

(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
Stability:: experimental

tags

(experimental) The tags associated with the origin endpoint.

Default:

No tagging

Stability:

experimental