aws-cdk-lib.aws_mediapackage.CfnOriginEndpointProps

CfnOriginEndpointProps Struct

Properties for defining a CfnOriginEndpoint.

CfnOriginEndpointProps

used as props by

• CfnOriginEndpoint

Source

Generated code

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

authorization?optionalIResolvable | CfnOriginEndpoint.AuthorizationPropertyauthorization?optionaltyping.Union[IResolvable, AuthorizationProperty]authorization?optionalIResolvableAuthorization?optionalIResolvableAuthorization?optionalinterface{}#

Parameters for CDN authorization.

channelIdstringchannel_idstrchannelIdStringChannelIdstringChannelId*stringrequired#

The ID of the channel associated with this endpoint.

cmafPackage?optionalIResolvable | CfnOriginEndpoint.CmafPackagePropertycmaf_package?optionaltyping.Union[IResolvable, CmafPackageProperty]cmafPackage?optionalIResolvableCmafPackage?optionalIResolvableCmafPackage?optionalinterface{}#

Parameters for Common Media Application Format (CMAF) packaging.

dashPackage?optionalIResolvable | CfnOriginEndpoint.DashPackagePropertydash_package?optionaltyping.Union[IResolvable, DashPackageProperty]dashPackage?optionalIResolvableDashPackage?optionalIResolvableDashPackage?optionalinterface{}#

Parameters for DASH packaging.

description?optionalstringdescription?optionalstrdescription?optionalStringDescription?optionalstringDescription?optional*string#

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

hlsPackage?optionalIResolvable | CfnOriginEndpoint.HlsPackagePropertyhls_package?optionaltyping.Union[IResolvable, HlsPackageProperty]hlsPackage?optionalIResolvableHlsPackage?optionalIResolvableHlsPackage?optionalinterface{}#

Parameters for Apple HLS packaging.

idstringidstridStringIdstringId*stringrequired#

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

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

manifestName?optionalstringmanifest_name?optionalstrmanifestName?optionalStringManifestName?optionalstringManifestName?optional*string#

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

mssPackage?optionalIResolvable | CfnOriginEndpoint.MssPackagePropertymss_package?optionaltyping.Union[IResolvable, MssPackageProperty]mssPackage?optionalIResolvableMssPackage?optionalIResolvableMssPackage?optionalinterface{}#

Parameters for Microsoft Smooth Streaming packaging.

origination?optionalstringorigination?optionalstrorigination?optionalStringOrigination?optionalstringOrigination?optional*string#

Controls video origination from this endpoint.

notes

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?optionalnumberstartover_window_seconds?optionalint | floatstartoverWindowSeconds?optionalNumberStartoverWindowSeconds?optionaldoubleStartoverWindowSeconds?optional*float64#

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?optionalCfnTag[]tags?optionaltyping.List[CfnTag]tags?optionalList<CfnTag>Tags?optionalCfnTag[]Tags?optional*[]CfnTag#

The tags to assign to the endpoint.

timeDelaySeconds?optionalnumbertime_delay_seconds?optionalint | floattimeDelaySeconds?optionalNumberTimeDelaySeconds?optionaldoubleTimeDelaySeconds?optional*float64#

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?optionalstring[]whitelist?optionaltyping.List[str]whitelist?optionalList<String>Whitelist?optionalstring[]Whitelist?optional*[]*string#

The IP addresses that can access this endpoint.