class CfnOriginEndpoint (construct)

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

Implements IConstruct, IDependable, IInspectable, IOriginEndpointRef, ITaggableV2

Specifies the configuration parameters for a MediaPackage V2 origin endpoint.

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 cfnOriginEndpoint = new mediapackagev2.CfnOriginEndpoint(this, 'MyCfnOriginEndpoint', {
  channelGroupName: 'channelGroupName',
  channelName: 'channelName',
  containerType: 'containerType',
  originEndpointName: 'originEndpointName',

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

    // the properties below are optional
    baseUrls: [{
      url: 'url',

      // the properties below are optional
      dvbPriority: 123,
      dvbWeight: 123,
      serviceLocation: 'serviceLocation',
    }],
    compactness: 'compactness',
    drmSignaling: 'drmSignaling',
    dvbSettings: {
      errorMetrics: [{
        reportingUrl: 'reportingUrl',

        // the properties below are optional
        probability: 123,
      }],
      fontDownload: {
        fontFamily: 'fontFamily',
        mimeType: 'mimeType',
        url: 'url',
      },
    },
    filterConfiguration: {
      clipStartTime: 'clipStartTime',
      end: 'end',
      manifestFilter: 'manifestFilter',
      start: 'start',
      timeDelaySeconds: 123,
    },
    manifestWindowSeconds: 123,
    minBufferTimeSeconds: 123,
    minUpdatePeriodSeconds: 123,
    periodTriggers: ['periodTriggers'],
    profiles: ['profiles'],
    programInformation: {
      copyright: 'copyright',
      languageCode: 'languageCode',
      moreInformationUrl: 'moreInformationUrl',
      source: 'source',
      title: 'title',
    },
    scteDash: {
      adMarkerDash: 'adMarkerDash',
    },
    segmentTemplateFormat: 'segmentTemplateFormat',
    subtitleConfiguration: {
      ttmlConfiguration: {
        ttmlProfile: 'ttmlProfile',
      },
    },
    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
      cmafExcludeSegmentDrmMetadata: false,
      constantInitializationVector: 'constantInitializationVector',
      keyRotationIntervalSeconds: 123,
    },
    includeIframeOnlyStreams: false,
    scte: {
      scteFilter: ['scteFilter'],
    },
    segmentDurationSeconds: 123,
    segmentName: 'segmentName',
    tsIncludeDvbSubtitles: false,
    tsUseAudioRenditionGroup: false,
  },
  startoverWindowSeconds: 123,
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnOriginEndpoint(scope: Construct, id: string, props: CfnOriginEndpointProps)

Parameters

• scope Construct — Scope in which this resource is defined.
• id string — Construct identifier for this resource (unique in its scope).
• props CfnOriginEndpointProps — Resource properties.

Construct Props

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

Properties

Name	Type	Description
attrArn	string	The Amazon Resource Name (ARN) of the origin endpoint.
attrCreatedAt	string	The timestamp of the creation of the origin endpoint.
attrDashManifestUrls	string[]	The egress domain URL for stream delivery from MediaPackage.
attrHlsManifestUrls	string[]	The egress domain URL for stream delivery from MediaPackage.
attrLowLatencyHlsManifestUrls	string[]	The egress domain URL for stream delivery from MediaPackage.
attrModifiedAt	string	The timestamp of the modification of the origin endpoint.
cdkTagManager	TagManager	Tag Manager which manages the tags for this resource.
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
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.
creationStack	string[]
logicalId	string	The logical ID for this CloudFormation stack element.
node	Node	The tree node.
originEndpointName	string	The name of the origin endpoint associated with the origin endpoint configuration.
originEndpointRef	OriginEndpointReference	A reference to a OriginEndpoint resource.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
stack	Stack	The stack in which this element is defined.
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.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrArn

Type: string

The Amazon Resource Name (ARN) of the origin endpoint.

---

attrCreatedAt

Type: string

The timestamp of the creation of the origin endpoint.

---

attrDashManifestUrls

Type: string[]

The egress domain URL for stream delivery from MediaPackage.

---

attrHlsManifestUrls

Type: string[]

The egress domain URL for stream delivery from MediaPackage.

---

attrLowLatencyHlsManifestUrls

Type: string[]

The egress domain URL for stream delivery from MediaPackage.

---

attrModifiedAt

Type: string

The timestamp of the modification of the origin endpoint.

---

cdkTagManager

Type: TagManager

Tag Manager which manages the tags for this resource.

---

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

channelGroupName

Type: string

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

---

channelName

Type: string

The channel name associated with the origin endpoint.

---

containerType

Type: string

The container type associated with the origin endpoint configuration.

---

creationStack

Type: string[]

---

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

node

Type: Node

The tree node.

---

originEndpointName

Type: string

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

---

originEndpointRef

Type: OriginEndpointReference

A reference to a OriginEndpoint resource.

---

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

---

dashManifests?

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

A DASH manifest configuration.

---

description?

Type: string (optional)

The description associated with the origin endpoint.

---

forceEndpointErrorConfiguration?

Type: IResolvable | ForceEndpointErrorConfigurationProperty (optional)

The failover settings for the endpoint.

---

hlsManifests?

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

The HLS manifests associated with the origin endpoint configuration.

---

lowLatencyHlsManifests?

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

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

---

segment?

Type: IResolvable | SegmentProperty (optional)

The segment associated with the origin endpoint.

---

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.

---

tags?

Type: CfnTag[] (optional)

The tags associated with the origin endpoint.

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

---

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

• path string — - The path of the property, you can use dot notation to override values in complex types.
• value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

---

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

• attributeName string — The name of the attribute.
• typeHint ResolutionTypeHint

Returns

• Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

obtainDependencies()

public obtainDependencies(): (Stack | CfnResource)[]

Returns

• (Stack | CfnResource)[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

---

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

• CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

---

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

---

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

• target CfnResource — The dependency to replace.
• newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }