interface IChannelGroup 🔹

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

Implements IDependable, IConstruct, IEnvironmentAware, IResource, IChannelGroupRef

Implemented by ChannelGroup

Obtainable from ChannelGroup.fromChannelGroupAttributes()

Interface for AWS Elemental MediaPackage V2 Channel Group.

Properties

Name	Type	Description
channelGroupArn🔹	string	The Amazon Resource Name (ARN) associated with the resource.
channelGroupName🔹	string	The name that describes the channel group.
channelGroupRef🔹	ChannelGroupReference	A reference to a ChannelGroup resource.
egressDomain🔹	string	The egress domain where packaged content is available.
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.
createdAt?🔹	string	The date and time the channel group was created.
modifiedAt?🔹	string	The date and time the channel group was modified.

---

channelGroupArn🔹

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.

---

channelGroupRef🔹

Type: ChannelGroupReference

A reference to a ChannelGroup resource.

---

egressDomain🔹

Type: string

The egress domain where packaged content is available.

Use this as the origin domain when configuring a CDN such as Amazon CloudFront.

---

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.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

createdAt?🔹

Type: string (optional)

The date and time the channel group was created.

---

modifiedAt?🔹

Type: string (optional)

The date and time the channel group was modified.

Methods

Name	Description
addChannel(id, options?)🔹	Add Channel for this Channel Group.
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.

---

addChannel(id, options?)🔹

public addChannel(id: string, options?: ChannelOptions): Channel

Parameters

• id string
• options ChannelOptions

Returns

• Channel

Add Channel for this Channel Group.

---

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.