AWS::MediaPackage::OriginEndpoint - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::MediaPackage::OriginEndpoint

Create an endpoint on an AWS Elemental MediaPackage channel.

An endpoint represents a single delivery point of a channel, and defines content output handling through various components, such as packaging protocols, DRM and encryption integration, and more.

After it's created, an endpoint provides a fixed public URL. This URL remains the same throughout the lifetime of the endpoint, regardless of any failures or upgrades that might occur. Integrate the URL with a downstream CDN (such as Amazon CloudFront) or playback device.

Syntax

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

JSON

{
  "Type" : "AWS::MediaPackage::OriginEndpoint",
  "Properties" : {
      "Authorization" : Authorization,
      "ChannelId" : String,
      "CmafPackage" : CmafPackage,
      "DashPackage" : DashPackage,
      "Description" : String,
      "HlsPackage" : HlsPackage,
      "Id" : String,
      "ManifestName" : String,
      "MssPackage" : MssPackage,
      "Origination" : String,
      "StartoverWindowSeconds" : Integer,
      "Tags" : [ Tag, ... ],
      "TimeDelaySeconds" : Integer,
      "Whitelist" : [ String, ... ]
    }
}

YAML

Type: AWS::MediaPackage::OriginEndpoint
Properties:
  Authorization: 
    Authorization
  ChannelId: String
  CmafPackage: 
    CmafPackage
  DashPackage: 
    DashPackage
  Description: String
  HlsPackage: 
    HlsPackage
  Id: String
  ManifestName: String
  MssPackage: 
    MssPackage
  Origination: String
  StartoverWindowSeconds: Integer
  Tags: 
    - Tag
  TimeDelaySeconds: Integer
  Whitelist: 
    - String

Properties

Authorization

Parameters for CDN authorization.

Required: No

Type: Authorization

Update requires: No interruption

ChannelId

The ID of the channel associated with this endpoint.

Required: Yes

Type: String

Update requires: No interruption

CmafPackage

Parameters for Common Media Application Format (CMAF) packaging.

Required: No

Type: CmafPackage

Update requires: No interruption

DashPackage

Parameters for DASH packaging.

Required: No

Type: DashPackage

Update requires: No interruption

Description

Any descriptive information that you want to add to the endpoint for future identification purposes.

Required: No

Type: String

Update requires: No interruption

HlsPackage

Parameters for Apple HLS packaging.

Required: No

Type: HlsPackage

Update requires: No interruption

Id

The manifest ID is required and must be unique within the OriginEndpoint. The ID can't be changed after the endpoint is created.

Required: Yes

Type: String

Pattern: \A[0-9a-zA-Z-_]+\Z

Minimum: 1

Maximum: 256

Update requires: Replacement

ManifestName

A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint.

Required: No

Type: String

Update requires: No interruption

MssPackage

Parameters for Microsoft Smooth Streaming packaging.

Required: No

Type: MssPackage

Update requires: No interruption

Origination

Controls video origination from this endpoint.

Valid values:

  • ALLOW - enables this endpoint to serve content to requesting devices.

  • DENY - prevents this endpoint from serving content. Denying origination is helpful for harvesting live-to-VOD assets. For more information about harvesting and origination, see Live-to-VOD Requirements.

Required: No

Type: String

Allowed values: ALLOW | DENY

Update requires: No interruption

StartoverWindowSeconds

Maximum duration (seconds) of content to retain for startover playback. Omit this attribute or enter 0 to indicate that startover playback is disabled for this endpoint.

Required: No

Type: Integer

Update requires: No interruption

Tags

The tags to assign to the endpoint.

Required: No

Type: Array of Tag

Update requires: No interruption

TimeDelaySeconds

Minimum duration (seconds) of delay to enforce on the playback of live content. Omit this attribute or enter 0 to indicate that there is no time delay in effect for this endpoint.

Required: No

Type: Integer

Update requires: No interruption

Whitelist

The IP addresses that can access this endpoint.

Required: No

Type: Array of String

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the name of the origin endpoint.

For example: { "Ref": "myOriginEndpoint" }

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

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The endpoint's unique system-generated resource name, based on the AWS record.

Url

URL for the key provider’s key retrieval API endpoint. Must start with https://.