This is the new *Amazon CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [Amazon CloudFormation User Guide](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::MediaPackage::OriginEndpoint
<a name="aws-resource-mediapackage-originendpoint"></a>

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
<a name="aws-resource-mediapackage-originendpoint-syntax"></a>

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

### JSON
<a name="aws-resource-mediapackage-originendpoint-syntax.json"></a>

```
{
  "Type" : "AWS::MediaPackage::OriginEndpoint",
  "Properties" : {
      "[Authorization](#cfn-mediapackage-originendpoint-authorization)" : {{Authorization}},
      "[ChannelId](#cfn-mediapackage-originendpoint-channelid)" : {{String}},
      "[CmafPackage](#cfn-mediapackage-originendpoint-cmafpackage)" : {{CmafPackage}},
      "[DashPackage](#cfn-mediapackage-originendpoint-dashpackage)" : {{DashPackage}},
      "[Description](#cfn-mediapackage-originendpoint-description)" : {{String}},
      "[HlsPackage](#cfn-mediapackage-originendpoint-hlspackage)" : {{HlsPackage}},
      "[Id](#cfn-mediapackage-originendpoint-id)" : {{String}},
      "[ManifestName](#cfn-mediapackage-originendpoint-manifestname)" : {{String}},
      "[MssPackage](#cfn-mediapackage-originendpoint-msspackage)" : {{MssPackage}},
      "[Origination](#cfn-mediapackage-originendpoint-origination)" : {{String}},
      "[StartoverWindowSeconds](#cfn-mediapackage-originendpoint-startoverwindowseconds)" : {{Integer}},
      "[Tags](#cfn-mediapackage-originendpoint-tags)" : {{[ Tag, ... ]}},
      "[TimeDelaySeconds](#cfn-mediapackage-originendpoint-timedelayseconds)" : {{Integer}},
      "[Whitelist](#cfn-mediapackage-originendpoint-whitelist)" : {{[ String, ... ]}}
    }
}
```

### YAML
<a name="aws-resource-mediapackage-originendpoint-syntax.yaml"></a>

```
Type: AWS::MediaPackage::OriginEndpoint
Properties:
  [Authorization](#cfn-mediapackage-originendpoint-authorization): {{
    Authorization}}
  [ChannelId](#cfn-mediapackage-originendpoint-channelid): {{String}}
  [CmafPackage](#cfn-mediapackage-originendpoint-cmafpackage): {{
    CmafPackage}}
  [DashPackage](#cfn-mediapackage-originendpoint-dashpackage): {{
    DashPackage}}
  [Description](#cfn-mediapackage-originendpoint-description): {{String}}
  [HlsPackage](#cfn-mediapackage-originendpoint-hlspackage): {{
    HlsPackage}}
  [Id](#cfn-mediapackage-originendpoint-id): {{String}}
  [ManifestName](#cfn-mediapackage-originendpoint-manifestname): {{String}}
  [MssPackage](#cfn-mediapackage-originendpoint-msspackage): {{
    MssPackage}}
  [Origination](#cfn-mediapackage-originendpoint-origination): {{String}}
  [StartoverWindowSeconds](#cfn-mediapackage-originendpoint-startoverwindowseconds): {{Integer}}
  [Tags](#cfn-mediapackage-originendpoint-tags): {{
    - Tag}}
  [TimeDelaySeconds](#cfn-mediapackage-originendpoint-timedelayseconds): {{Integer}}
  [Whitelist](#cfn-mediapackage-originendpoint-whitelist): {{
    - String}}
```

## Properties
<a name="aws-resource-mediapackage-originendpoint-properties"></a>

`Authorization`  <a name="cfn-mediapackage-originendpoint-authorization"></a>
Parameters for CDN authorization.  
*Required*: No  
*Type*: [Authorization](aws-properties-mediapackage-originendpoint-authorization.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ChannelId`  <a name="cfn-mediapackage-originendpoint-channelid"></a>
The ID of the channel associated with this endpoint.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CmafPackage`  <a name="cfn-mediapackage-originendpoint-cmafpackage"></a>
Parameters for Common Media Application Format (CMAF) packaging.  
*Required*: No  
*Type*: [CmafPackage](aws-properties-mediapackage-originendpoint-cmafpackage.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DashPackage`  <a name="cfn-mediapackage-originendpoint-dashpackage"></a>
Parameters for DASH packaging.  
*Required*: No  
*Type*: [DashPackage](aws-properties-mediapackage-originendpoint-dashpackage.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-mediapackage-originendpoint-description"></a>
Any descriptive information that you want to add to the endpoint for future identification purposes.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`HlsPackage`  <a name="cfn-mediapackage-originendpoint-hlspackage"></a>
Parameters for Apple HLS packaging.  
*Required*: No  
*Type*: [HlsPackage](aws-properties-mediapackage-originendpoint-hlspackage.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Id`  <a name="cfn-mediapackage-originendpoint-id"></a>
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](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ManifestName`  <a name="cfn-mediapackage-originendpoint-manifestname"></a>
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](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MssPackage`  <a name="cfn-mediapackage-originendpoint-msspackage"></a>
Parameters for Microsoft Smooth Streaming packaging.  
*Required*: No  
*Type*: [MssPackage](aws-properties-mediapackage-originendpoint-msspackage.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Origination`  <a name="cfn-mediapackage-originendpoint-origination"></a>
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](https://docs.amazonaws.cn/mediapackage/latest/ug/ltov-reqmts.html).
*Required*: No  
*Type*: String  
*Allowed values*: `ALLOW | DENY`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StartoverWindowSeconds`  <a name="cfn-mediapackage-originendpoint-startoverwindowseconds"></a>
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](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-mediapackage-originendpoint-tags"></a>
The tags to assign to the endpoint.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-mediapackage-originendpoint-tag.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimeDelaySeconds`  <a name="cfn-mediapackage-originendpoint-timedelayseconds"></a>
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](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Whitelist`  <a name="cfn-mediapackage-originendpoint-whitelist"></a>
The IP addresses that can access this endpoint.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-mediapackage-originendpoint-return-values"></a>

### Ref
<a name="aws-resource-mediapackage-originendpoint-return-values-ref"></a>

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 [https://docs.amazonaws.cn/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.amazonaws.cn/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-mediapackage-originendpoint-return-values-fn--getatt"></a>

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 [https://docs.amazonaws.cn/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.amazonaws.cn/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-mediapackage-originendpoint-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The endpoint's unique system-generated resource name, based on the Amazon record.

`Url`  <a name="Url-fn::getatt"></a>
URL for the key provider’s key retrieval API endpoint. Must start with https://.