AWS::MediaPackageV2::OriginEndpoint

Specifies the configuration parameters for a MediaPackage V2 origin endpoint.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::MediaPackageV2::OriginEndpoint",
  "Properties" : {
      "ChannelGroupName" : String,
      "ChannelName" : String,
      "ContainerType" : String,
      "DashManifests" : [ DashManifestConfiguration, ... ],
      "Description" : String,
      "ForceEndpointErrorConfiguration" : ForceEndpointErrorConfiguration,
      "HlsManifests" : [ HlsManifestConfiguration, ... ],
      "LowLatencyHlsManifests" : [ LowLatencyHlsManifestConfiguration, ... ],
      "OriginEndpointName" : String,
      "Segment" : Segment,
      "StartoverWindowSeconds" : Integer,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::MediaPackageV2::OriginEndpoint
Properties:
  ChannelGroupName: String
  ChannelName: String
  ContainerType: String
  DashManifests: 
    - DashManifestConfiguration
  Description: String
  ForceEndpointErrorConfiguration: 
    ForceEndpointErrorConfiguration
  HlsManifests: 
    - HlsManifestConfiguration
  LowLatencyHlsManifests: 
    - LowLatencyHlsManifestConfiguration
  OriginEndpointName: String
  Segment: 
    Segment
  StartoverWindowSeconds: Integer
  Tags: 
    - Tag

Properties

ChannelGroupName

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

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_-]+$

Minimum: 1

Maximum: 256

Update requires: Replacement

ChannelName

The channel name associated with the origin endpoint.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_-]+$

Minimum: 1

Maximum: 256

Update requires: Replacement

ContainerType

The container type associated with the origin endpoint configuration.

Required: Yes

Type: String

Allowed values: TS | CMAF

Update requires: No interruption

DashManifests

A DASH manifest configuration.

Required: No

Type: Array of DashManifestConfiguration

Update requires: No interruption

Description

The description associated with the origin endpoint.

Required: No

Type: String

Minimum: 0

Maximum: 1024

Update requires: No interruption

ForceEndpointErrorConfiguration

The failover settings for the endpoint.

Required: No

Type: ForceEndpointErrorConfiguration

Update requires: No interruption

HlsManifests

The HLS manfiests associated with the origin endpoint configuration.

Required: No

Type: Array of HlsManifestConfiguration

Update requires: No interruption

LowLatencyHlsManifests

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

Required: No

Type: Array of LowLatencyHlsManifestConfiguration

Update requires: No interruption

OriginEndpointName

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

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_-]+$

Minimum: 1

Maximum: 256

Update requires: Replacement

Segment

The segment associated with the origin endpoint.

Required: No

Type: Segment

Update requires: No interruption

StartoverWindowSeconds

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.

Required: No

Type: Integer

Minimum: 60

Maximum: 1209600

Update requires: No interruption

Tags

The tags associated with the origin endpoint.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns arn:aws:mediapackagev2:region:AccountId:ChannelGroup|ChannelGroupName|Channel|ChannelName|OriginEndpoint|OriginEndpointName .

For more information about using the Ref function, see Ref.

Fn::GetAtt

The attributes of the origin endpoint. You can only use the GetAtt function for readOnly properties. For example, you can use the GetAtt function to retrieve the read-only CreatedAt property.

Arn

The Amazon Resource Name (ARN) of the origin endpoint.

CreatedAt

The timestamp of the creation of the origin endpoint.

DashManifestUrls

Property description not available.

HlsManifestUrls

Property description not available.

LowLatencyHlsManifestUrls

Property description not available.

ModifiedAt

The timestamp of the modification of the origin endpoint.