interface IChannel 🔹

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

Implements IDependable, IConstruct, IEnvironmentAware, IResource, IChannelRef

Implemented by Channel

Obtainable from Channel.fromChannelAttributes()

Represents a MediaPackage V2 Channel.

Properties

Name	Type	Description
channelArn🔹	string	The Amazon Resource Name (ARN) associated with the resource.
channelGroupName🔹	string	The name that describes the channel group.
channelName🔹	string	The name that describes the channel.
channelRef🔹	ChannelReference	A reference to a Channel resource.
env🔹	ResourceEnvironment	The environment this resource belongs to.
grants🔹	ChannelGrants	Grants IAM resource policy to the role used to write to MediaPackage V2 Channel.
ingestEndpointUrls🔹	string[]	The ingest endpoint URLs for the channel.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.
channelGroup?🔹	IChannelGroup	The channel group this channel belongs to.
createdAt?🔹	string	The date and time the channel was created.
modifiedAt?🔹	string	The date and time the channel was modified.

---

channelArn🔹

Type: string

The Amazon Resource Name (ARN) associated with the resource.

---

channelGroupName🔹

Type: string

The name that describes the channel group.

The name is the primary identifier for the channel group.

---

channelName🔹

Type: string

The name that describes the channel.

The name is the primary identifier for the channel.

---

channelRef🔹

Type: ChannelReference

A reference to a Channel resource.

---

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.

---

grants🔹

Type: ChannelGrants

Grants IAM resource policy to the role used to write to MediaPackage V2 Channel.

---

ingestEndpointUrls🔹

Type: string[]

The ingest endpoint URLs for the channel.

---

node🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

channelGroup?🔹

Type: IChannelGroup (optional)

The channel group this channel belongs to.

Only available when the channel was created in the same stack. Undefined for imported channels.

---

createdAt?🔹

Type: string (optional)

The date and time the channel was created.

---

modifiedAt?🔹

Type: string (optional)

The date and time the channel was modified.

Methods

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

---

addOriginEndpoint(id, options)🔹

public addOriginEndpoint(id: string, options: OriginEndpointOptions): OriginEndpoint

Parameters

• id string
• options OriginEndpointOptions

Returns

• OriginEndpoint

Add Origin Endpoint for this Channel.

---

addToResourcePolicy(statement)🔹

public addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult

Parameters

• statement PolicyStatement

Returns

• AddToResourcePolicyResult

Configure channel policy.

You can only add 1 ChannelPolicy to a Channel. If you have already defined one, function will append 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(options?)🔹

public metricEgressBytes(options?: MetricOptions): Metric

Parameters

• options MetricOptions

Returns

• Metric

Returns Metric for Egress Bytes.

---

metricEgressRequestCount(options?)🔹

public metricEgressRequestCount(options?: MetricOptions): Metric

Parameters

• options MetricOptions

Returns

• Metric

Returns Metric for Egress Request Count.

---

metricEgressResponseTime(options?)🔹

public metricEgressResponseTime(options?: MetricOptions): Metric

Parameters

• options 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(options?)🔹

public metricIngressRequestCount(options?: MetricOptions): Metric

Parameters

• options MetricOptions

Returns

• Metric

Returns Metric for Ingress Request Count.

---

metricIngressResponseTime(options?)🔹

public metricIngressResponseTime(options?: MetricOptions): Metric

Parameters

• options 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.