origin_endpoints

Creates, updates, deletes or gets an origin_endpoint resource or lists origin_endpoints in a region

Overview

Name	origin_endpoints
Type	Resource
Description	Resource schema for AWS::MediaPackage::OriginEndpoint
Id	aws.mediapackage.origin_endpoints

Fields

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) assigned to the OriginEndpoint.
url	string	The URL of the packaged OriginEndpoint for consumption.
id	string	The ID of the OriginEndpoint.
channel_id	string	The ID of the Channel the OriginEndpoint is associated with.
description	string	A short text description of the OriginEndpoint.
whitelist	array	A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
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.
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.
manifest_name	string	A short string appended to the end of the OriginEndpoint URL.
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
authorization	object
hls_package	object	An HTTP Live Streaming (HLS) packaging configuration.
dash_package	object	A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
mss_package	object	A Microsoft Smooth Streaming (MSS) PackagingConfiguration.
cmaf_package	object	A CMAF packaging configuration.
tags	array	A collection of tags associated with a resource
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Id, ChannelId, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all origin_endpoints in a region.

SELECT
region,
arn,
url,
id,
channel_id,
description,
whitelist,
startover_window_seconds,
time_delay_seconds,
manifest_name,
origination,
authorization,
hls_package,
dash_package,
mss_package,
cmaf_package,
tags
FROM aws.mediapackage.origin_endpoints
WHERE region = 'us-east-1';

Gets all properties from an individual origin_endpoint.

SELECT
region,
arn,
url,
id,
channel_id,
description,
whitelist,
startover_window_seconds,
time_delay_seconds,
manifest_name,
origination,
authorization,
hls_package,
dash_package,
mss_package,
cmaf_package,
tags
FROM aws.mediapackage.origin_endpoints
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

Use the following StackQL query and manifest file to create a new origin_endpoint resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.mediapackage.origin_endpoints (
 Id,
 ChannelId,
 region
)
SELECT 
'{{ Id }}',
 '{{ ChannelId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.mediapackage.origin_endpoints (
 Id,
 ChannelId,
 Description,
 Whitelist,
 StartoverWindowSeconds,
 TimeDelaySeconds,
 ManifestName,
 Origination,
 Authorization,
 HlsPackage,
 DashPackage,
 MssPackage,
 CmafPackage,
 Tags,
 region
)
SELECT 
 '{{ Id }}',
 '{{ ChannelId }}',
 '{{ Description }}',
 '{{ Whitelist }}',
 '{{ StartoverWindowSeconds }}',
 '{{ TimeDelaySeconds }}',
 '{{ ManifestName }}',
 '{{ Origination }}',
 '{{ Authorization }}',
 '{{ HlsPackage }}',
 '{{ DashPackage }}',
 '{{ MssPackage }}',
 '{{ CmafPackage }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: origin_endpoint
    props:
      - name: Id
        value: '{{ Id }}'
      - name: ChannelId
        value: '{{ ChannelId }}'
      - name: Description
        value: '{{ Description }}'
      - name: Whitelist
        value:
          - '{{ Whitelist[0] }}'
      - name: StartoverWindowSeconds
        value: '{{ StartoverWindowSeconds }}'
      - name: TimeDelaySeconds
        value: '{{ TimeDelaySeconds }}'
      - name: ManifestName
        value: '{{ ManifestName }}'
      - name: Origination
        value: '{{ Origination }}'
      - name: Authorization
        value:
          CdnIdentifierSecret: '{{ CdnIdentifierSecret }}'
          SecretsRoleArn: '{{ SecretsRoleArn }}'
      - name: HlsPackage
        value:
          Encryption:
            ConstantInitializationVector: '{{ ConstantInitializationVector }}'
            EncryptionMethod: '{{ EncryptionMethod }}'
            SpekeKeyProvider:
              EncryptionContractConfiguration:
                PresetSpeke20Audio: '{{ PresetSpeke20Audio }}'
                PresetSpeke20Video: '{{ PresetSpeke20Video }}'
              RoleArn: '{{ RoleArn }}'
              SystemIds:
                - '{{ SystemIds[0] }}'
              Url: '{{ Url }}'
          HlsManifests:
            - AdMarkers: '{{ AdMarkers }}'
              IncludeIframeOnlyStream: '{{ IncludeIframeOnlyStream }}'
              ManifestName: '{{ ManifestName }}'
              ProgramDateTimeIntervalSeconds: '{{ ProgramDateTimeIntervalSeconds }}'
              RepeatExtXKey: '{{ RepeatExtXKey }}'
              StreamSelection:
                MaxVideoBitsPerSecond: '{{ MaxVideoBitsPerSecond }}'
                MinVideoBitsPerSecond: '{{ MinVideoBitsPerSecond }}'
                StreamOrder: '{{ StreamOrder }}'
          IncludeDvbSubtitles: '{{ IncludeDvbSubtitles }}'
          SegmentDurationSeconds: '{{ SegmentDurationSeconds }}'
          UseAudioRenditionGroup: '{{ UseAudioRenditionGroup }}'
      - name: DashPackage
        value:
          DashManifests:
            - ManifestLayout: '{{ ManifestLayout }}'
              ManifestName: null
              MinBufferTimeSeconds: '{{ MinBufferTimeSeconds }}'
              Profile: '{{ Profile }}'
              ScteMarkersSource: '{{ ScteMarkersSource }}'
              StreamSelection: null
          Encryption:
            SpekeKeyProvider: null
          PeriodTriggers:
            - '{{ PeriodTriggers[0] }}'
          SegmentDurationSeconds: null
          SegmentTemplateFormat: '{{ SegmentTemplateFormat }}'
          IncludeEncoderConfigurationInSegments: '{{ IncludeEncoderConfigurationInSegments }}'
          IncludeIframeOnlyStream: '{{ IncludeIframeOnlyStream }}'
      - name: MssPackage
        value:
          Encryption:
            SpekeKeyProvider: null
          MssManifests:
            - ManifestName: null
              StreamSelection: null
          SegmentDurationSeconds: null
      - name: CmafPackage
        value:
          Encryption:
            SpekeKeyProvider: null
          HlsManifests:
            - null
          SegmentDurationSeconds: null
          IncludeEncoderConfigurationInSegments: '{{ IncludeEncoderConfigurationInSegments }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.mediapackage.origin_endpoints
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

To operate on the origin_endpoints resource, the following permissions are required:

Create

mediapackage:CreateOriginEndpoint,
mediapackage:DescribeOriginEndpoint,
mediapackage:DescribeChannel,
mediapackage:TagResource,
iam:PassRole,
acm:DescribeCertificate

Read

mediapackage:DescribeOriginEndpoint

Update

mediapackage:UpdateOriginEndpoint,
iam:PassRole

Delete

mediapackage:DeleteOriginEndpoint

List

mediapackage:ListOriginEndpoints