interface IOriginEndpoint 🔹

Language	Type name
.NET	Amazon.CDK.AWS.MediaPackageV2.Alpha.IOriginEndpoint
Go	github.com/aws/aws-cdk-go/awsmediapackagev2alpha/v2#IOriginEndpoint
Java	software.amazon.awscdk.services.mediapackagev2.alpha.IOriginEndpoint
Python	aws_cdk.aws_mediapackagev2_alpha.IOriginEndpoint
TypeScript (source)	@aws-cdk/aws-mediapackagev2-alpha » IOriginEndpoint

Implements IDependable, IConstruct, IEnvironmentAware, IResource, IOriginEndpointRef

Implemented by OriginEndpoint

Obtainable from OriginEndpoint.fromOriginEndpointAttributes()

Origin Endpoint interface.

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.
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	Node	The tree node.
originEndpointArn🔹	string	The Amazon Resource Name (ARN) of the origin endpoint.
originEndpointName🔹	string	The name of the origin endpoint associated with the origin endpoint configuration.
originEndpointRef🔹	OriginEndpointReference	A reference to a OriginEndpoint resource.
stack🔹	Stack	The stack in which this resource is defined.
createdAt?🔹	string	The date and time the origin endpoint was created.
dashManifestUrls?🔹	string[]	The DASH manifest URLs for the origin endpoint.
hlsManifestUrls?🔹	string[]	The HLS manifest URLs for the origin endpoint.
lowLatencyHlsManifestUrls?🔹	string[]	The Low Latency HLS manifest URLs for the origin endpoint.
modifiedAt?🔹	string	The date and time the origin endpoint was modified.
mssManifestUrls?🔹	string[]	The MSS manifest URLs for the origin endpoint.

---

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.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

node🔹

Type: Node

The tree node.

---

originEndpointArn🔹

Type: string

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

---

originEndpointName🔹

Type: string

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

---

originEndpointRef🔹

Type: OriginEndpointReference

A reference to a OriginEndpoint resource.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

createdAt?🔹

Type: string (optional)

The date and time the origin endpoint was created.

---

dashManifestUrls?🔹

Type: string[] (optional)

The DASH manifest URLs for the origin endpoint.

---

hlsManifestUrls?🔹

Type: string[] (optional)

The HLS manifest URLs for the origin endpoint.

---

lowLatencyHlsManifestUrls?🔹

Type: string[] (optional)

The Low Latency HLS manifest URLs for the origin endpoint.

---

modifiedAt?🔹

Type: string (optional)

The date and time the origin endpoint was modified.

---

mssManifestUrls?🔹

Type: string[] (optional)

The MSS manifest URLs for the origin endpoint.

Methods

Name	Description
addToResourcePolicy(statement, cdnAuth?)🔹	Configure origin endpoint policy.
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
metric(metricName, props?)🔹	Create a CloudWatch metric.
metricEgressBytes(props?)🔹	Returns Metric for Egress Bytes.
metricEgressRequestCount(props?)🔹	Returns Metric for Egress Request Count.
metricEgressResponseTime(props?)🔹	Returns Metric for Egress Response time.
metricIngressBytes(options?)🔹	Returns Metric for Ingress Bytes.
metricIngressRequestCount(props?)🔹	Returns Metric for Ingress Request Count.
metricIngressResponseTime(props?)🔹	Returns Metric for Ingress response time.
with(...mixins)🔹	Applies one or more mixins to this construct.

---

addToResourcePolicy(statement, cdnAuth?)🔹

public addToResourcePolicy(statement: PolicyStatement, cdnAuth?: CdnAuthConfiguration): AddToResourcePolicyResult

Parameters

• statement PolicyStatement — - The policy statement to add.
• cdnAuth CdnAuthConfiguration — - Optional CDN authorization configuration.

Returns

• AddToResourcePolicyResult

Configure origin endpoint policy.

You can only add 1 OriginEndpointPolicy to an OriginEndpoint. If you have already defined one, it will append to the policy already created.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

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).

---

metric(metricName, props?)🔹

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

• metricName string — name of the metric.
• props MetricOptions — metric options.

Returns

• Metric

Create a CloudWatch metric.

---

metricEgressBytes(props?)🔹

public metricEgressBytes(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Returns Metric for Egress Bytes.

---

metricEgressRequestCount(props?)🔹

public metricEgressRequestCount(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Returns Metric for Egress Request Count.

---

metricEgressResponseTime(props?)🔹

public metricEgressResponseTime(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Returns Metric for Egress Response time.

---

metricIngressBytes(options?)🔹

public metricIngressBytes(options?: MetricOptions): Metric

Parameters

• options MetricOptions

Returns

• Metric

Returns Metric for Ingress Bytes.

---

metricIngressRequestCount(props?)🔹

public metricIngressRequestCount(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Returns Metric for Ingress Request Count.

---

metricIngressResponseTime(props?)🔹

public metricIngressResponseTime(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Returns Metric for Ingress response time.

---

with(...mixins)🔹

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin — The mixins to apply.

Returns

• IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.