interface CfnOriginEndpointProps

Language	Type name
.NET	`Amazon.CDK.AWS.MediaPackage.CfnOriginEndpointProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsmediapackage#CfnOriginEndpointProps`
Java	`software.amazon.awscdk.services.mediapackage.CfnOriginEndpointProps`
Python	`aws_cdk.aws_mediapackage.CfnOriginEndpointProps`
TypeScript	`aws-cdk-lib` » `aws_mediapackage` » `CfnOriginEndpointProps`

Properties for defining a CfnOriginEndpoint.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mediapackage as mediapackage } from 'aws-cdk-lib';
const cfnOriginEndpointProps: mediapackage.CfnOriginEndpointProps = {
  channelId: 'channelId',
  id: 'id',

  // the properties below are optional
  authorization: {
    cdnIdentifierSecret: 'cdnIdentifierSecret',
    secretsRoleArn: 'secretsRoleArn',
  },
  cmafPackage: {
    encryption: {
      spekeKeyProvider: {
        resourceId: 'resourceId',
        roleArn: 'roleArn',
        systemIds: ['systemIds'],
        url: 'url',

        // the properties below are optional
        certificateArn: 'certificateArn',
        encryptionContractConfiguration: {
          presetSpeke20Audio: 'presetSpeke20Audio',
          presetSpeke20Video: 'presetSpeke20Video',
        },
      },

      // the properties below are optional
      constantInitializationVector: 'constantInitializationVector',
      encryptionMethod: 'encryptionMethod',
      keyRotationIntervalSeconds: 123,
    },
    hlsManifests: [{
      id: 'id',

      // the properties below are optional
      adMarkers: 'adMarkers',
      adsOnDeliveryRestrictions: 'adsOnDeliveryRestrictions',
      adTriggers: ['adTriggers'],
      includeIframeOnlyStream: false,
      manifestName: 'manifestName',
      playlistType: 'playlistType',
      playlistWindowSeconds: 123,
      programDateTimeIntervalSeconds: 123,
      url: 'url',
    }],
    segmentDurationSeconds: 123,
    segmentPrefix: 'segmentPrefix',
    streamSelection: {
      maxVideoBitsPerSecond: 123,
      minVideoBitsPerSecond: 123,
      streamOrder: 'streamOrder',
    },
  },
  dashPackage: {
    adsOnDeliveryRestrictions: 'adsOnDeliveryRestrictions',
    adTriggers: ['adTriggers'],
    encryption: {
      spekeKeyProvider: {
        resourceId: 'resourceId',
        roleArn: 'roleArn',
        systemIds: ['systemIds'],
        url: 'url',

        // the properties below are optional
        certificateArn: 'certificateArn',
        encryptionContractConfiguration: {
          presetSpeke20Audio: 'presetSpeke20Audio',
          presetSpeke20Video: 'presetSpeke20Video',
        },
      },

      // the properties below are optional
      keyRotationIntervalSeconds: 123,
    },
    includeIframeOnlyStream: false,
    manifestLayout: 'manifestLayout',
    manifestWindowSeconds: 123,
    minBufferTimeSeconds: 123,
    minUpdatePeriodSeconds: 123,
    periodTriggers: ['periodTriggers'],
    profile: 'profile',
    segmentDurationSeconds: 123,
    segmentTemplateFormat: 'segmentTemplateFormat',
    streamSelection: {
      maxVideoBitsPerSecond: 123,
      minVideoBitsPerSecond: 123,
      streamOrder: 'streamOrder',
    },
    suggestedPresentationDelaySeconds: 123,
    utcTiming: 'utcTiming',
    utcTimingUri: 'utcTimingUri',
  },
  description: 'description',
  hlsPackage: {
    adMarkers: 'adMarkers',
    adsOnDeliveryRestrictions: 'adsOnDeliveryRestrictions',
    adTriggers: ['adTriggers'],
    encryption: {
      spekeKeyProvider: {
        resourceId: 'resourceId',
        roleArn: 'roleArn',
        systemIds: ['systemIds'],
        url: 'url',

        // the properties below are optional
        certificateArn: 'certificateArn',
        encryptionContractConfiguration: {
          presetSpeke20Audio: 'presetSpeke20Audio',
          presetSpeke20Video: 'presetSpeke20Video',
        },
      },

      // the properties below are optional
      constantInitializationVector: 'constantInitializationVector',
      encryptionMethod: 'encryptionMethod',
      keyRotationIntervalSeconds: 123,
      repeatExtXKey: false,
    },
    includeDvbSubtitles: false,
    includeIframeOnlyStream: false,
    playlistType: 'playlistType',
    playlistWindowSeconds: 123,
    programDateTimeIntervalSeconds: 123,
    segmentDurationSeconds: 123,
    streamSelection: {
      maxVideoBitsPerSecond: 123,
      minVideoBitsPerSecond: 123,
      streamOrder: 'streamOrder',
    },
    useAudioRenditionGroup: false,
  },
  manifestName: 'manifestName',
  mssPackage: {
    encryption: {
      spekeKeyProvider: {
        resourceId: 'resourceId',
        roleArn: 'roleArn',
        systemIds: ['systemIds'],
        url: 'url',

        // the properties below are optional
        certificateArn: 'certificateArn',
        encryptionContractConfiguration: {
          presetSpeke20Audio: 'presetSpeke20Audio',
          presetSpeke20Video: 'presetSpeke20Video',
        },
      },
    },
    manifestWindowSeconds: 123,
    segmentDurationSeconds: 123,
    streamSelection: {
      maxVideoBitsPerSecond: 123,
      minVideoBitsPerSecond: 123,
      streamOrder: 'streamOrder',
    },
  },
  origination: 'origination',
  startoverWindowSeconds: 123,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  timeDelaySeconds: 123,
  whitelist: ['whitelist'],
};

Properties

Name	Type	Description
channelId	`string`	The ID of the channel associated with this endpoint.
id	`string`	The manifest ID is required and must be unique within the OriginEndpoint.
authorization?	`IResolvable` `\|` `AuthorizationProperty`	Parameters for CDN authorization.
cmafPackage?	`IResolvable` `\|` `CmafPackageProperty`	Parameters for Common Media Application Format (CMAF) packaging.
dashPackage?	`IResolvable` `\|` `DashPackageProperty`	Parameters for DASH packaging.
description?	`string`	Any descriptive information that you want to add to the endpoint for future identification purposes.
hlsPackage?	`IResolvable` `\|` `HlsPackageProperty`	Parameters for Apple HLS packaging.
manifestName?	`string`	A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint.
mssPackage?	`IResolvable` `\|` `MssPackageProperty`	Parameters for Microsoft Smooth Streaming packaging.
origination?	`string`	Controls video origination from this endpoint.
startoverWindowSeconds?	`number`	Maximum duration (seconds) of content to retain for startover playback.
tags?	`CfnTag[]`	The tags to assign to the endpoint.
timeDelaySeconds?	`number`	Minimum duration (seconds) of delay to enforce on the playback of live content.
whitelist?	`string[]`	The IP addresses that can access this endpoint.

channelId

Type: string

The ID of the channel associated with this endpoint.

id

Type: string

The manifest ID is required and must be unique within the OriginEndpoint.

The ID can't be changed after the endpoint is created.

authorization?

Type: IResolvable | AuthorizationProperty (optional)

Parameters for CDN authorization.

cmafPackage?

Type: IResolvable | CmafPackageProperty (optional)

Parameters for Common Media Application Format (CMAF) packaging.

dashPackage?

Type: IResolvable | DashPackageProperty (optional)

Parameters for DASH packaging.

description?

Type: string (optional)

Any descriptive information that you want to add to the endpoint for future identification purposes.

hlsPackage?

Type: IResolvable | HlsPackageProperty (optional)

Parameters for Apple HLS packaging.

manifestName?

Type: string (optional)

A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint.

mssPackage?

Type: IResolvable | MssPackageProperty (optional)

Parameters for Microsoft Smooth Streaming packaging.

origination?

Type: string (optional)

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 .

startoverWindowSeconds?

Type: number (optional)

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.

tags?

Type: CfnTag[] (optional)

The tags to assign to the endpoint.

timeDelaySeconds?

Type: number (optional)

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.

whitelist?

Type: string[] (optional)

The IP addresses that can access this endpoint.