class ChannelPlacementGroup (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.MediaLive.Alpha.ChannelPlacementGroup
Go	github.com/aws/aws-cdk-go/awsmedialivealpha/v2#ChannelPlacementGroup
Java	software.amazon.awscdk.services.medialive.alpha.ChannelPlacementGroup
Python	aws_cdk.aws_medialive_alpha.ChannelPlacementGroup
TypeScript (source)	@aws-cdk/aws-medialive-alpha » ChannelPlacementGroup

Implements IConstruct, IDependable, IResource, IEnvironmentAware, IChannelPlacementGroup, IChannelPlacementGroupRef

Defines an AWS Elemental MediaLive Channel Placement Group.

A channel placement group assigns channels to specific nodes within a cluster.

Example

declare const stack: Stack;
declare const cluster: medialive.ICluster;
declare const input: medialive.IInput;
declare const video: medialive.EncodeConfiguration;
declare const bucket: s3.IBucket;

const cpg = new medialive.ChannelPlacementGroup(stack, 'CPG', {
  channelPlacementGroupName: 'my-cpg',
  cluster,
});

new medialive.Channel(stack, 'AnywhereChannel', {
  inputs: [{ input }],
  anywhereSettings: { cluster, channelPlacementGroup: cpg },
  outputGroups: [
    medialive.OutputGroupConfiguration.hls({
      name: 'hls',
      destinations: [medialive.OutputDestination.toBucket(bucket, 'live/stream')],
      outputs: [{ encodes: [video], outputName: 'hls_out' }],
    }),
  ],
});

Initializer

new ChannelPlacementGroup(scope: Construct, id: string, props: ChannelPlacementGroupProps)

Parameters

• scope Construct
• id string
• props ChannelPlacementGroupProps

Construct Props

Name	Type	Description
cluster🔹	IClusterRef	The cluster this channel placement group belongs to.
channelPlacementGroupName?🔹	string	The name of the channel placement group.
nodes?🔹	string[]	List of node IDs for the channel placement group.
tags?🔹	{ [string]: string }	Tags to add to the channel placement group.

---

cluster🔹

Type: IClusterRef

The cluster this channel placement group belongs to.

---

channelPlacementGroupName?🔹

Type: string (optional, default: auto-generated name)

The name of the channel placement group.

---

nodes?🔹

Type: string[] (optional, default: no nodes)

List of node IDs for the channel placement group.

---

tags?🔹

Type: { [string]: string } (optional, default: no tags)

Tags to add to the channel placement group.

Properties

Name	Type	Description
channelPlacementGroupArn🔹	string	The ARN of the channel placement group.
channelPlacementGroupId🔹	string	The ID of the channel placement group.
channelPlacementGroupRef🔹	ChannelPlacementGroupReference	A reference to this Channel Placement Group resource.
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.
static PROPERTY_INJECTION_ID🔹	string	Uniquely identifies this class.

---

channelPlacementGroupArn🔹

Type: string

The ARN of the channel placement group.

---

channelPlacementGroupId🔹

Type: string

The ID of the channel placement group.

---

channelPlacementGroupRef🔹

Type: ChannelPlacementGroupReference

A reference to this Channel Placement Group 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.

---

node🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

static PROPERTY_INJECTION_ID🔹

Type: string

Uniquely identifies this class.

Methods

Name	Description
applyCrossStackReferenceStrength(strength)🔹	Override the cross-stack reference strength for this resource.
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
toString()🔹	Returns a string representation of this construct.
with(...mixins)🔹	Applies one or more mixins to this construct.
static fromChannelPlacementGroupAttributes(scope, id, attrs)🔹	Import an existing channel placement group by its attributes.

---

applyCrossStackReferenceStrength(strength)🔹

public applyCrossStackReferenceStrength(strength: ReferenceStrength): void

Parameters

• strength ReferenceStrength — - The reference strength to use for this resource.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

---

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

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

with(...mixins)🔹

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

Parameters

• mixins IMixin

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. Use multiple with() calls if subsequent mixins should apply to added constructs.

---

static fromChannelPlacementGroupAttributes(scope, id, attrs)🔹

public static fromChannelPlacementGroupAttributes(scope: Construct, id: string, attrs: ChannelPlacementGroupAttributes): IChannelPlacementGroup

Parameters

• scope Construct
• id string
• attrs ChannelPlacementGroupAttributes

Returns

• IChannelPlacementGroup

Import an existing channel placement group by its attributes.