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	Represents an origin endpoint that is associated with a channel, offering a dynamically repackaged version of its content through various streaming media protocols. The content can be efficiently disseminated to end-users via a Content Delivery Network (CDN), like Amazon CloudFront.
Id	awscc.mediapackagev2.origin_endpoints

Fields

Name	Datatype	Description
arn	string	<p>The Amazon Resource Name (ARN) associated with the resource.</p>
channel_group_name	string
channel_name	string
container_type	string
created_at	string	<p>The date and time the origin endpoint was created.</p>
▶dash_manifests	array	<p>A DASH manifest configuration.</p>
description	string	<p>Enter any descriptive text that helps you to identify the origin endpoint.</p>
▶force_endpoint_error_configuration	object	<p>The failover settings for the endpoint.</p>
▶hls_manifests	array	<p>An HTTP live streaming (HLS) manifest configuration.</p>
▶low_latency_hls_manifests	array	<p>A low-latency HLS manifest configuration.</p>
modified_at	string	<p>The date and time the origin endpoint was modified.</p>
origin_endpoint_name	string
▶segment	object	<p>The segment configuration, including the segment name, duration, and other configuration values.</p>
startover_window_seconds	integer	<p>The size of the window (in seconds) to create 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. The maximum startover window is 1,209,600 seconds (14 days).</p>
dash_manifest_urls	array
hls_manifest_urls	array
low_latency_hls_manifest_urls	array
▶tags	array
region	string	AWS region.

For more information, see AWS::MediaPackageV2::OriginEndpoint.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ChannelGroupName, ChannelName, OriginEndpointName, ContainerType, 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 properties from an individual origin_endpoint.

SELECT
region,
arn,
channel_group_name,
channel_name,
container_type,
created_at,
dash_manifests,
description,
force_endpoint_error_configuration,
hls_manifests,
low_latency_hls_manifests,
modified_at,
origin_endpoint_name,
segment,
startover_window_seconds,
dash_manifest_urls,
hls_manifest_urls,
low_latency_hls_manifest_urls,
tags
FROM awscc.mediapackagev2.origin_endpoints
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

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 awscc.mediapackagev2.origin_endpoints (
 ChannelGroupName,
 ChannelName,
 ContainerType,
 OriginEndpointName,
 region
)
SELECT 
'{{ ChannelGroupName }}',
 '{{ ChannelName }}',
 '{{ ContainerType }}',
 '{{ OriginEndpointName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.mediapackagev2.origin_endpoints (
 ChannelGroupName,
 ChannelName,
 ContainerType,
 DashManifests,
 Description,
 ForceEndpointErrorConfiguration,
 HlsManifests,
 LowLatencyHlsManifests,
 OriginEndpointName,
 Segment,
 StartoverWindowSeconds,
 Tags,
 region
)
SELECT 
 '{{ ChannelGroupName }}',
 '{{ ChannelName }}',
 '{{ ContainerType }}',
 '{{ DashManifests }}',
 '{{ Description }}',
 '{{ ForceEndpointErrorConfiguration }}',
 '{{ HlsManifests }}',
 '{{ LowLatencyHlsManifests }}',
 '{{ OriginEndpointName }}',
 '{{ Segment }}',
 '{{ StartoverWindowSeconds }}',
 '{{ 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: ChannelGroupName
        value: '{{ ChannelGroupName }}'
      - name: ChannelName
        value: '{{ ChannelName }}'
      - name: ContainerType
        value: '{{ ContainerType }}'
      - name: DashManifests
        value:
          - ManifestName: '{{ ManifestName }}'
            ManifestWindowSeconds: '{{ ManifestWindowSeconds }}'
            FilterConfiguration:
              ManifestFilter: '{{ ManifestFilter }}'
              Start: '{{ Start }}'
              End: '{{ End }}'
              TimeDelaySeconds: '{{ TimeDelaySeconds }}'
              ClipStartTime: '{{ ClipStartTime }}'
            MinUpdatePeriodSeconds: '{{ MinUpdatePeriodSeconds }}'
            MinBufferTimeSeconds: '{{ MinBufferTimeSeconds }}'
            SuggestedPresentationDelaySeconds: '{{ SuggestedPresentationDelaySeconds }}'
            SegmentTemplateFormat: '{{ SegmentTemplateFormat }}'
            PeriodTriggers:
              - '{{ PeriodTriggers[0] }}'
            ScteDash:
              AdMarkerDash: '{{ AdMarkerDash }}'
            DrmSignaling: '{{ DrmSignaling }}'
            UtcTiming:
              TimingMode: '{{ TimingMode }}'
              TimingSource: '{{ TimingSource }}'
            Profiles:
              - '{{ Profiles[0] }}'
            BaseUrls:
              - Url: '{{ Url }}'
                ServiceLocation: '{{ ServiceLocation }}'
                DvbPriority: '{{ DvbPriority }}'
                DvbWeight: '{{ DvbWeight }}'
            ProgramInformation:
              Title: '{{ Title }}'
              Source: '{{ Source }}'
              Copyright: '{{ Copyright }}'
              LanguageCode: '{{ LanguageCode }}'
              MoreInformationUrl: '{{ MoreInformationUrl }}'
            DvbSettings:
              FontDownload:
                Url: '{{ Url }}'
                MimeType: '{{ MimeType }}'
                FontFamily: '{{ FontFamily }}'
              ErrorMetrics:
                - ReportingUrl: '{{ ReportingUrl }}'
                  Probability: '{{ Probability }}'
            Compactness: '{{ Compactness }}'
            SubtitleConfiguration:
              TtmlConfiguration:
                TtmlProfile: '{{ TtmlProfile }}'
      - name: Description
        value: '{{ Description }}'
      - name: ForceEndpointErrorConfiguration
        value:
          EndpointErrorConditions:
            - '{{ EndpointErrorConditions[0] }}'
      - name: HlsManifests
        value:
          - ManifestName: '{{ ManifestName }}'
            Url: '{{ Url }}'
            ChildManifestName: '{{ ChildManifestName }}'
            ManifestWindowSeconds: '{{ ManifestWindowSeconds }}'
            ProgramDateTimeIntervalSeconds: '{{ ProgramDateTimeIntervalSeconds }}'
            ScteHls:
              AdMarkerHls: '{{ AdMarkerHls }}'
            FilterConfiguration: null
            StartTag:
              TimeOffset: null
              Precise: '{{ Precise }}'
            UrlEncodeChildManifest: '{{ UrlEncodeChildManifest }}'
      - name: LowLatencyHlsManifests
        value:
          - ManifestName: '{{ ManifestName }}'
            Url: '{{ Url }}'
            ChildManifestName: '{{ ChildManifestName }}'
            ManifestWindowSeconds: '{{ ManifestWindowSeconds }}'
            ProgramDateTimeIntervalSeconds: '{{ ProgramDateTimeIntervalSeconds }}'
            ScteHls: null
            FilterConfiguration: null
            StartTag: null
            UrlEncodeChildManifest: '{{ UrlEncodeChildManifest }}'
      - name: OriginEndpointName
        value: '{{ OriginEndpointName }}'
      - name: Segment
        value:
          SegmentDurationSeconds: '{{ SegmentDurationSeconds }}'
          SegmentName: '{{ SegmentName }}'
          TsUseAudioRenditionGroup: '{{ TsUseAudioRenditionGroup }}'
          IncludeIframeOnlyStreams: '{{ IncludeIframeOnlyStreams }}'
          TsIncludeDvbSubtitles: '{{ TsIncludeDvbSubtitles }}'
          Scte:
            ScteFilter:
              - '{{ ScteFilter[0] }}'
          Encryption:
            ConstantInitializationVector: '{{ ConstantInitializationVector }}'
            EncryptionMethod:
              TsEncryptionMethod: '{{ TsEncryptionMethod }}'
              CmafEncryptionMethod: '{{ CmafEncryptionMethod }}'
            KeyRotationIntervalSeconds: '{{ KeyRotationIntervalSeconds }}'
            CmafExcludeSegmentDrmMetadata: '{{ CmafExcludeSegmentDrmMetadata }}'
            SpekeKeyProvider:
              EncryptionContractConfiguration:
                PresetSpeke20Audio: '{{ PresetSpeke20Audio }}'
                PresetSpeke20Video: '{{ PresetSpeke20Video }}'
              ResourceId: '{{ ResourceId }}'
              DrmSystems:
                - '{{ DrmSystems[0] }}'
              RoleArn: '{{ RoleArn }}'
              Url: '{{ Url }}'
      - name: StartoverWindowSeconds
        value: '{{ StartoverWindowSeconds }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.mediapackagev2.origin_endpoints
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

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

Create

mediapackagev2:TagResource,
mediapackagev2:CreateOriginEndpoint,
iam:PassRole

Read

mediapackagev2:GetOriginEndpoint

Update

mediapackagev2:TagResource,
mediapackagev2:UntagResource,
mediapackagev2:ListTagsForResource,
mediapackagev2:UpdateOriginEndpoint,
iam:PassRole

Delete

mediapackagev2:GetOriginEndpoint,
mediapackagev2:DeleteOriginEndpoint

List

mediapackagev2:ListOriginEndpoints