origin_endpoints

Creates, updates, deletes, gets or lists an origin_endpoints resource.

Overview

Name	origin_endpoints
Type	Resource
Id	aws.mediapackage.origin_endpoints

Fields

The following fields are returned by SELECT queries:

describe_origin_endpoint

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) assigned to the OriginEndpoint.
authorization	object	CDN Authorization credentials
channel_id	string	The ID of the Channel the OriginEndpoint is associated with.
cmaf_package	object	A Common Media Application Format (CMAF) packaging configuration.
created_at	string	The date and time the OriginEndpoint was created.
dash_package	object	A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
description	string	A short text description of the OriginEndpoint.
hls_package	object	An HTTP Live Streaming (HLS) packaging configuration.
id	string	The ID of the OriginEndpoint.
manifest_name	string	A short string appended to the end of the OriginEndpoint URL.
mss_package	object	A Microsoft Smooth Streaming (MSS) packaging configuration.
origination	string	Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination (ALLOW, DENY)
startover_window_seconds	integer	Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.
tags	object
time_delay_seconds	integer	Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.
url	string	The URL of the packaged OriginEndpoint for consumption.
whitelist	array	A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.

list_origin_endpoints

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) assigned to the OriginEndpoint.
authorization	object	CDN Authorization credentials
channel_id	string	The ID of the Channel the OriginEndpoint is associated with.
cmaf_package	object	A Common Media Application Format (CMAF) packaging configuration.
created_at	string	The date and time the OriginEndpoint was created.
dash_package	object	A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
description	string	A short text description of the OriginEndpoint.
hls_package	object	An HTTP Live Streaming (HLS) packaging configuration.
id	string	The ID of the OriginEndpoint.
manifest_name	string	A short string appended to the end of the OriginEndpoint URL.
mss_package	object	A Microsoft Smooth Streaming (MSS) packaging configuration.
origination	string	Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination (ALLOW, DENY)
startover_window_seconds	integer	Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.
tags	object
time_delay_seconds	integer	Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.
url	string	The URL of the packaged OriginEndpoint for consumption.
whitelist	array	A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_origin_endpoint	select	id, region		Gets details about an existing OriginEndpoint.
list_origin_endpoints	select	region	channelId, maxResults, nextToken	Returns a collection of OriginEndpoint records.
create_origin_endpoint	insert	region, ChannelId		Creates a new OriginEndpoint record.
update_origin_endpoint	update	id, region		Updates an existing OriginEndpoint.
delete_origin_endpoint	delete	id, region		Deletes an existing OriginEndpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The ID of the OriginEndpoint to delete.
region	string	AWS region (default: us-east-1)
channelId	string	When specified, the request will return only OriginEndpoints associated with the given Channel ID.
maxResults	integer	The upper bound on the number of records to return.
nextToken	string	A token used to resume pagination from the end of a previous request.

SELECT examples

describe_origin_endpoint

Gets details about an existing OriginEndpoint.

SELECT
arn,
authorization,
channel_id,
cmaf_package,
created_at,
dash_package,
description,
hls_package,
id,
manifest_name,
mss_package,
origination,
startover_window_seconds,
tags,
time_delay_seconds,
url,
whitelist
FROM aws.mediapackage.origin_endpoints
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_origin_endpoints

Returns a collection of OriginEndpoint records.

SELECT
arn,
authorization,
channel_id,
cmaf_package,
created_at,
dash_package,
description,
hls_package,
id,
manifest_name,
mss_package,
origination,
startover_window_seconds,
tags,
time_delay_seconds,
url,
whitelist
FROM aws.mediapackage.origin_endpoints
WHERE region = '{{ region }}' -- required
AND channelId = '{{ channelId }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_origin_endpoint

Creates a new OriginEndpoint record.

INSERT INTO aws.mediapackage.origin_endpoints (
Authorization,
ChannelId,
CmafPackage,
DashPackage,
Description,
HlsPackage,
Id,
ManifestName,
MssPackage,
Origination,
StartoverWindowSeconds,
Tags,
TimeDelaySeconds,
Whitelist,
region
)
SELECT 
'{{ Authorization }}',
'{{ ChannelId }}' /* required */,
'{{ CmafPackage }}',
'{{ DashPackage }}',
'{{ Description }}',
'{{ HlsPackage }}',
'{{ Id }}',
'{{ ManifestName }}',
'{{ MssPackage }}',
'{{ Origination }}',
{{ StartoverWindowSeconds }},
'{{ Tags }}',
{{ TimeDelaySeconds }},
'{{ Whitelist }}',
'{{ region }}'
RETURNING
arn,
authorization,
channel_id,
cmaf_package,
created_at,
dash_package,
description,
hls_package,
id,
manifest_name,
mss_package,
origination,
startover_window_seconds,
tags,
time_delay_seconds,
url,
whitelist
;

Manifest

# Description fields are for documentation purposes
- name: origin_endpoints
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the origin_endpoints resource.
  - name: Authorization
    description: |
      CDN Authorization credentials
    value:
      CdnIdentifierSecret: "{{ CdnIdentifierSecret }}"
      SecretsRoleArn: "{{ SecretsRoleArn }}"
  - name: ChannelId
    value: "{{ ChannelId }}"
  - name: CmafPackage
    description: |
      A Common Media Application Format (CMAF) packaging configuration.
    value:
      Encryption:
        ConstantInitializationVector: "{{ ConstantInitializationVector }}"
        EncryptionMethod: "{{ EncryptionMethod }}"
        KeyRotationIntervalSeconds: {{ KeyRotationIntervalSeconds }}
        SpekeKeyProvider:
          CertificateArn: "{{ CertificateArn }}"
          EncryptionContractConfiguration:
            PresetSpeke20Audio: "{{ PresetSpeke20Audio }}"
            PresetSpeke20Video: "{{ PresetSpeke20Video }}"
          ResourceId: "{{ ResourceId }}"
          RoleArn: "{{ RoleArn }}"
          SystemIds:
            - "{{ SystemIds }}"
          Url: "{{ Url }}"
      HlsManifests:
        - AdMarkers: "{{ AdMarkers }}"
          AdTriggers: "{{ AdTriggers }}"
          AdsOnDeliveryRestrictions: "{{ AdsOnDeliveryRestrictions }}"
          Id: "{{ Id }}"
          IncludeIframeOnlyStream: {{ IncludeIframeOnlyStream }}
          ManifestName: "{{ ManifestName }}"
          PlaylistType: "{{ PlaylistType }}"
          PlaylistWindowSeconds: {{ PlaylistWindowSeconds }}
          ProgramDateTimeIntervalSeconds: {{ ProgramDateTimeIntervalSeconds }}
      SegmentDurationSeconds: {{ SegmentDurationSeconds }}
      SegmentPrefix: "{{ SegmentPrefix }}"
      StreamSelection:
        MaxVideoBitsPerSecond: {{ MaxVideoBitsPerSecond }}
        MinVideoBitsPerSecond: {{ MinVideoBitsPerSecond }}
        StreamOrder: "{{ StreamOrder }}"
  - name: DashPackage
    description: |
      A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
    value:
      AdTriggers:
        - "{{ AdTriggers }}"
      AdsOnDeliveryRestrictions: "{{ AdsOnDeliveryRestrictions }}"
      Encryption:
        KeyRotationIntervalSeconds: {{ KeyRotationIntervalSeconds }}
        SpekeKeyProvider:
          CertificateArn: "{{ CertificateArn }}"
          EncryptionContractConfiguration:
            PresetSpeke20Audio: "{{ PresetSpeke20Audio }}"
            PresetSpeke20Video: "{{ PresetSpeke20Video }}"
          ResourceId: "{{ ResourceId }}"
          RoleArn: "{{ RoleArn }}"
          SystemIds:
            - "{{ SystemIds }}"
          Url: "{{ Url }}"
      IncludeIframeOnlyStream: {{ IncludeIframeOnlyStream }}
      ManifestLayout: "{{ ManifestLayout }}"
      ManifestWindowSeconds: {{ ManifestWindowSeconds }}
      MinBufferTimeSeconds: {{ MinBufferTimeSeconds }}
      MinUpdatePeriodSeconds: {{ MinUpdatePeriodSeconds }}
      PeriodTriggers:
        - "{{ PeriodTriggers }}"
      Profile: "{{ Profile }}"
      SegmentDurationSeconds: {{ SegmentDurationSeconds }}
      SegmentTemplateFormat: "{{ SegmentTemplateFormat }}"
      StreamSelection:
        MaxVideoBitsPerSecond: {{ MaxVideoBitsPerSecond }}
        MinVideoBitsPerSecond: {{ MinVideoBitsPerSecond }}
        StreamOrder: "{{ StreamOrder }}"
      SuggestedPresentationDelaySeconds: {{ SuggestedPresentationDelaySeconds }}
      UtcTiming: "{{ UtcTiming }}"
      UtcTimingUri: "{{ UtcTimingUri }}"
  - name: Description
    value: "{{ Description }}"
  - name: HlsPackage
    description: |
      An HTTP Live Streaming (HLS) packaging configuration.
    value:
      AdMarkers: "{{ AdMarkers }}"
      AdTriggers:
        - "{{ AdTriggers }}"
      AdsOnDeliveryRestrictions: "{{ AdsOnDeliveryRestrictions }}"
      Encryption:
        ConstantInitializationVector: "{{ ConstantInitializationVector }}"
        EncryptionMethod: "{{ EncryptionMethod }}"
        KeyRotationIntervalSeconds: {{ KeyRotationIntervalSeconds }}
        RepeatExtXKey: {{ RepeatExtXKey }}
        SpekeKeyProvider:
          CertificateArn: "{{ CertificateArn }}"
          EncryptionContractConfiguration:
            PresetSpeke20Audio: "{{ PresetSpeke20Audio }}"
            PresetSpeke20Video: "{{ PresetSpeke20Video }}"
          ResourceId: "{{ ResourceId }}"
          RoleArn: "{{ RoleArn }}"
          SystemIds:
            - "{{ SystemIds }}"
          Url: "{{ Url }}"
      IncludeDvbSubtitles: {{ IncludeDvbSubtitles }}
      IncludeIframeOnlyStream: {{ IncludeIframeOnlyStream }}
      PlaylistType: "{{ PlaylistType }}"
      PlaylistWindowSeconds: {{ PlaylistWindowSeconds }}
      ProgramDateTimeIntervalSeconds: {{ ProgramDateTimeIntervalSeconds }}
      SegmentDurationSeconds: {{ SegmentDurationSeconds }}
      StreamSelection:
        MaxVideoBitsPerSecond: {{ MaxVideoBitsPerSecond }}
        MinVideoBitsPerSecond: {{ MinVideoBitsPerSecond }}
        StreamOrder: "{{ StreamOrder }}"
      UseAudioRenditionGroup: {{ UseAudioRenditionGroup }}
  - name: Id
    value: "{{ Id }}"
  - name: ManifestName
    value: "{{ ManifestName }}"
  - name: MssPackage
    description: |
      A Microsoft Smooth Streaming (MSS) packaging configuration.
    value:
      Encryption:
        SpekeKeyProvider:
          CertificateArn: "{{ CertificateArn }}"
          EncryptionContractConfiguration:
            PresetSpeke20Audio: "{{ PresetSpeke20Audio }}"
            PresetSpeke20Video: "{{ PresetSpeke20Video }}"
          ResourceId: "{{ ResourceId }}"
          RoleArn: "{{ RoleArn }}"
          SystemIds:
            - "{{ SystemIds }}"
          Url: "{{ Url }}"
      ManifestWindowSeconds: {{ ManifestWindowSeconds }}
      SegmentDurationSeconds: {{ SegmentDurationSeconds }}
      StreamSelection:
        MaxVideoBitsPerSecond: {{ MaxVideoBitsPerSecond }}
        MinVideoBitsPerSecond: {{ MinVideoBitsPerSecond }}
        StreamOrder: "{{ StreamOrder }}"
  - name: Origination
    value: "{{ Origination }}"
    valid_values: ['ALLOW', 'DENY']
  - name: StartoverWindowSeconds
    value: {{ StartoverWindowSeconds }}
  - name: Tags
    value: "{{ Tags }}"
    description: |
      A collection of tags associated with a resource
  - name: TimeDelaySeconds
    value: {{ TimeDelaySeconds }}
  - name: Whitelist
    value:
      - "{{ Whitelist }}"

UPDATE examples

update_origin_endpoint

Updates an existing OriginEndpoint.

UPDATE aws.mediapackage.origin_endpoints
SET 
Authorization = '{{ Authorization }}',
CmafPackage = '{{ CmafPackage }}',
DashPackage = '{{ DashPackage }}',
Description = '{{ Description }}',
HlsPackage = '{{ HlsPackage }}',
ManifestName = '{{ ManifestName }}',
MssPackage = '{{ MssPackage }}',
Origination = '{{ Origination }}',
StartoverWindowSeconds = {{ StartoverWindowSeconds }},
TimeDelaySeconds = {{ TimeDelaySeconds }},
Whitelist = '{{ Whitelist }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
RETURNING
arn,
authorization,
channel_id,
cmaf_package,
created_at,
dash_package,
description,
hls_package,
id,
manifest_name,
mss_package,
origination,
startover_window_seconds,
tags,
time_delay_seconds,
url,
whitelist;

DELETE examples

delete_origin_endpoint

Deletes an existing OriginEndpoint.

DELETE FROM aws.mediapackage.origin_endpoints
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
;