Skip to content
v2.277.0

Experimental

@aws-cdk/aws-mediapackagev2-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

ChannelAttributes Struct ​

Represents a Channel defined outside of this stack.

Example ​

ts
declare const stack: Stack;
const channel = Channel.fromChannelAttributes(stack, 'ImportedChannel', {
    channelName: 'MyChannel',
    channelGroupName: 'MyChannelGroup',
});
python
# stack: Stack

channel = Channel.from_channel_attributes(stack, "ImportedChannel",
    channel_name="MyChannel",
    channel_group_name="MyChannelGroup"
)
java
Stack stack;

IChannel channel = Channel.fromChannelAttributes(stack, "ImportedChannel", ChannelAttributes.builder()
        .channelName("MyChannel")
        .channelGroupName("MyChannelGroup")
        .build());
csharp
// Install: dotnet add package Amazon.CDK.AWS.MediaPackageV2.Alpha
Stack stack;

var channel = Channel.FromChannelAttributes(stack, "ImportedChannel", new ChannelAttributes {
    ChannelName = "MyChannel",
    ChannelGroupName = "MyChannelGroup"
});
go
// Install: go get github.com/aws/aws-cdk-go/awsmediapackagev2alpha/v2
var stack Stack

channel := awsmediapackagev2alpha.Channel_FromChannelAttributes(stack, jsii.String("ImportedChannel"), &ChannelAttributes{
	ChannelName: jsii.String("MyChannel"),
	ChannelGroupName: jsii.String("MyChannelGroup"),
})

Properties ​

channelGroupNamestringchannel_group_namestrchannelGroupNameStringChannelGroupNamestringChannelGroupName*stringrequired#
The name that describes the channel group.
channelNamestringchannel_namestrchannelNameStringChannelNamestringChannelName*stringrequired#
The name that describes the channel.
regionoptionalstringregionoptionalstrregionoptionalStringRegionoptionalstringRegionoptional*string#
The AWS region where the channel lives.

Default: the importing stack's region

Required for cross-region imports to construct the correct ARN.