interface CfnOriginEndpointProps

Language	Type name
.NET	Amazon.CDK.aws_mediapackagev2.CfnOriginEndpointProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsmediapackagev2#CfnOriginEndpointProps
Java	software.amazon.awscdk.services.mediapackagev2.CfnOriginEndpointProps
Python	aws_cdk.aws_mediapackagev2.CfnOriginEndpointProps
TypeScript	aws-cdk-lib » aws_mediapackagev2 » CfnOriginEndpointProps

Properties for defining a CfnOriginEndpoint.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mediapackagev2 as mediapackagev2 } from 'aws-cdk-lib';
const cfnOriginEndpointProps: mediapackagev2.CfnOriginEndpointProps = {
  channelGroupName: 'channelGroupName',
  channelName: 'channelName',
  containerType: 'containerType',
  originEndpointName: 'originEndpointName',

  // the properties below are optional
  dashManifests: [{
    manifestName: 'manifestName',

    // the properties below are optional
    drmSignaling: 'drmSignaling',
    filterConfiguration: {
      clipStartTime: 'clipStartTime',
      end: 'end',
      manifestFilter: 'manifestFilter',
      start: 'start',
      timeDelaySeconds: 123,
    },
    manifestWindowSeconds: 123,
    minBufferTimeSeconds: 123,
    minUpdatePeriodSeconds: 123,
    periodTriggers: ['periodTriggers'],
    scteDash: {
      adMarkerDash: 'adMarkerDash',
    },
    segmentTemplateFormat: 'segmentTemplateFormat',
    suggestedPresentationDelaySeconds: 123,
    utcTiming: {
      timingMode: 'timingMode',
      timingSource: 'timingSource',
    },
  }],
  description: 'description',
  forceEndpointErrorConfiguration: {
    endpointErrorConditions: ['endpointErrorConditions'],
  },
  hlsManifests: [{
    manifestName: 'manifestName',

    // the properties below are optional
    childManifestName: 'childManifestName',
    filterConfiguration: {
      clipStartTime: 'clipStartTime',
      end: 'end',
      manifestFilter: 'manifestFilter',
      start: 'start',
      timeDelaySeconds: 123,
    },
    manifestWindowSeconds: 123,
    programDateTimeIntervalSeconds: 123,
    scteHls: {
      adMarkerHls: 'adMarkerHls',
    },
    startTag: {
      timeOffset: 123,

      // the properties below are optional
      precise: false,
    },
    url: 'url',
    urlEncodeChildManifest: false,
  }],
  lowLatencyHlsManifests: [{
    manifestName: 'manifestName',

    // the properties below are optional
    childManifestName: 'childManifestName',
    filterConfiguration: {
      clipStartTime: 'clipStartTime',
      end: 'end',
      manifestFilter: 'manifestFilter',
      start: 'start',
      timeDelaySeconds: 123,
    },
    manifestWindowSeconds: 123,
    programDateTimeIntervalSeconds: 123,
    scteHls: {
      adMarkerHls: 'adMarkerHls',
    },
    startTag: {
      timeOffset: 123,

      // the properties below are optional
      precise: false,
    },
    url: 'url',
    urlEncodeChildManifest: false,
  }],
  segment: {
    encryption: {
      encryptionMethod: {
        cmafEncryptionMethod: 'cmafEncryptionMethod',
        tsEncryptionMethod: 'tsEncryptionMethod',
      },
      spekeKeyProvider: {
        drmSystems: ['drmSystems'],
        encryptionContractConfiguration: {
          presetSpeke20Audio: 'presetSpeke20Audio',
          presetSpeke20Video: 'presetSpeke20Video',
        },
        resourceId: 'resourceId',
        roleArn: 'roleArn',
        url: 'url',
      },

      // the properties below are optional
      constantInitializationVector: 'constantInitializationVector',
      keyRotationIntervalSeconds: 123,
    },
    includeIframeOnlyStreams: false,
    scte: {
      scteFilter: ['scteFilter'],
    },
    segmentDurationSeconds: 123,
    segmentName: 'segmentName',
    tsIncludeDvbSubtitles: false,
    tsUseAudioRenditionGroup: false,
  },
  startoverWindowSeconds: 123,
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
channelGroupName	string	The name of the channel group associated with the origin endpoint configuration.
channelName	string	The channel name associated with the origin endpoint.
containerType	string	The container type associated with the origin endpoint configuration.
originEndpointName	string	The name of the origin endpoint associated with the origin endpoint configuration.
dashManifests?	IResolvable | IResolvable | DashManifestConfigurationProperty[]	A DASH manifest configuration.
description?	string	The description associated with the origin endpoint.
forceEndpointErrorConfiguration?	IResolvable | ForceEndpointErrorConfigurationProperty	The failover settings for the endpoint.
hlsManifests?	IResolvable | IResolvable | HlsManifestConfigurationProperty[]	The HLS manifests associated with the origin endpoint configuration.
lowLatencyHlsManifests?	IResolvable | IResolvable | LowLatencyHlsManifestConfigurationProperty[]	The low-latency HLS (LL-HLS) manifests associated with the origin endpoint.
segment?	IResolvable | SegmentProperty	The segment associated with the origin endpoint.
startoverWindowSeconds?	number	The size of the window (in seconds) to specify a window of the live stream that's available for on-demand viewing.
tags?	CfnTag[]	The tags associated with the origin endpoint.

---

channelGroupName

Type: string

The name of the channel group associated with the origin endpoint configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-channelgroupname

---

channelName

Type: string

The channel name associated with the origin endpoint.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-channelname

---

containerType

Type: string

The container type associated with the origin endpoint configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-containertype

---

originEndpointName

Type: string

The name of the origin endpoint associated with the origin endpoint configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-originendpointname

---

dashManifests?

Type: IResolvable | IResolvable | DashManifestConfigurationProperty[] (optional)

A DASH manifest configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-dashmanifests

---

description?

Type: string (optional)

The description associated with the origin endpoint.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-description

---

forceEndpointErrorConfiguration?

Type: IResolvable | ForceEndpointErrorConfigurationProperty (optional)

The failover settings for the endpoint.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-forceendpointerrorconfiguration

---

hlsManifests?

Type: IResolvable | IResolvable | HlsManifestConfigurationProperty[] (optional)

The HLS manifests associated with the origin endpoint configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-hlsmanifests

---

lowLatencyHlsManifests?

Type: IResolvable | IResolvable | LowLatencyHlsManifestConfigurationProperty[] (optional)

The low-latency HLS (LL-HLS) manifests associated with the origin endpoint.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-lowlatencyhlsmanifests

---

segment?

Type: IResolvable | SegmentProperty (optional)

The segment associated with the origin endpoint.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-segment

---

startoverWindowSeconds?

Type: number (optional)

The size of the window (in seconds) to specify 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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-startoverwindowseconds

---

tags?

Type: CfnTag[] (optional)

The tags associated with the origin endpoint.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediapackagev2-originendpoint.html#cfn-mediapackagev2-originendpoint-tags