Channel class
Resource for managing an AWS MediaLive Channel.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.medialive.Channel("example", {
inputSpecification: {
codec: "AVC",
inputResolution: "HD",
maximumBitrate: "MAX_20_MBPS",
},
encoderSettings: {
timecodeConfig: {
source: "EMBEDDED",
},
audioDescriptions: [{
audioSelectorName: "example audio selector",
name: "audio-selector",
}],
outputGroups: [{
outputGroupSettings: {
archiveGroupSettings: [{
destination: {
destinationRefId: "destination",
},
}],
},
outputs: [{
outputSettings: {
archiveOutputSettings: {
containerSettings: {
m2tsSettings: {
audioBufferModel: "ATSC",
bufferModel: "MULTIPLEX",
rateMode: "CBR",
},
},
nameModifier: "_1",
extension: "m2ts",
},
},
outputName: "example-name",
videoDescriptionName: "example-video",
audioDescriptionNames: ["audio-selector"],
}],
}],
videoDescriptions: [{
name: "example-video",
}],
},
destinations: [{
settings: [
{
url: `s3://${main.id}/test1`,
},
{
url: `s3://${main2.id}/test2`,
},
],
id: "destination",
}],
inputAttachments: [{
inputAttachmentName: "example-input",
inputId: exampleAwsMedialiveInput.id,
}],
name: "example-channel",
channelClass: "STANDARD",
roleArn: exampleAwsIamRole.arn,
});
import pulumi
import pulumi_aws as aws
example = aws.medialive.Channel("example",
input_specification={
"codec": "AVC",
"input_resolution": "HD",
"maximum_bitrate": "MAX_20_MBPS",
},
encoder_settings={
"timecode_config": {
"source": "EMBEDDED",
},
"audio_descriptions": [{
"audio_selector_name": "example audio selector",
"name": "audio-selector",
}],
"output_groups": [{
"output_group_settings": {
"archive_group_settings": [{
"destination": {
"destination_ref_id": "destination",
},
}],
},
"outputs": [{
"output_settings": {
"archive_output_settings": {
"container_settings": {
"m2ts_settings": {
"audio_buffer_model": "ATSC",
"buffer_model": "MULTIPLEX",
"rate_mode": "CBR",
},
},
"name_modifier": "_1",
"extension": "m2ts",
},
},
"output_name": "example-name",
"video_description_name": "example-video",
"audio_description_names": ["audio-selector"],
}],
}],
"video_descriptions": [{
"name": "example-video",
}],
},
destinations=[{
"settings": [
{
"url": f"s3://{main['id']}/test1",
},
{
"url": f"s3://{main2['id']}/test2",
},
],
"id": "destination",
}],
input_attachments=[{
"input_attachment_name": "example-input",
"input_id": example_aws_medialive_input["id"],
}],
name="example-channel",
channel_class="STANDARD",
role_arn=example_aws_iam_role["arn"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.MediaLive.Channel("example", new()
{
InputSpecification = new Aws.MediaLive.Inputs.ChannelInputSpecificationArgs
{
Codec = "AVC",
InputResolution = "HD",
MaximumBitrate = "MAX_20_MBPS",
},
EncoderSettings = new Aws.MediaLive.Inputs.ChannelEncoderSettingsArgs
{
TimecodeConfig = new Aws.MediaLive.Inputs.ChannelEncoderSettingsTimecodeConfigArgs
{
Source = "EMBEDDED",
},
AudioDescriptions = new[]
{
new Aws.MediaLive.Inputs.ChannelEncoderSettingsAudioDescriptionArgs
{
AudioSelectorName = "example audio selector",
Name = "audio-selector",
},
},
OutputGroups = new[]
{
new Aws.MediaLive.Inputs.ChannelEncoderSettingsOutputGroupArgs
{
OutputGroupSettings = new Aws.MediaLive.Inputs.ChannelEncoderSettingsOutputGroupOutputGroupSettingsArgs
{
ArchiveGroupSettings = new[]
{
new Aws.MediaLive.Inputs.ChannelEncoderSettingsOutputGroupOutputGroupSettingsArchiveGroupSettingArgs
{
Destination = new Aws.MediaLive.Inputs.ChannelEncoderSettingsOutputGroupOutputGroupSettingsArchiveGroupSettingDestinationArgs
{
DestinationRefId = "destination",
},
},
},
},
Outputs = new[]
{
new Aws.MediaLive.Inputs.ChannelEncoderSettingsOutputGroupOutputArgs
{
OutputSettings = new Aws.MediaLive.Inputs.ChannelEncoderSettingsOutputGroupOutputOutputSettingsArgs
{
ArchiveOutputSettings = new Aws.MediaLive.Inputs.ChannelEncoderSettingsOutputGroupOutputOutputSettingsArchiveOutputSettingsArgs
{
ContainerSettings = new Aws.MediaLive.Inputs.ChannelEncoderSettingsOutputGroupOutputOutputSettingsArchiveOutputSettingsContainerSettingsArgs
{
M2tsSettings = new Aws.MediaLive.Inputs.ChannelEncoderSettingsOutputGroupOutputOutputSettingsArchiveOutputSettingsContainerSettingsM2tsSettingsArgs
{
AudioBufferModel = "ATSC",
BufferModel = "MULTIPLEX",
RateMode = "CBR",
},
},
NameModifier = "_1",
Extension = "m2ts",
},
},
OutputName = "example-name",
VideoDescriptionName = "example-video",
AudioDescriptionNames = new[]
{
"audio-selector",
},
},
},
},
},
VideoDescriptions = new[]
{
new Aws.MediaLive.Inputs.ChannelEncoderSettingsVideoDescriptionArgs
{
Name = "example-video",
},
},
},
Destinations = new[]
{
new Aws.MediaLive.Inputs.ChannelDestinationArgs
{
Settings = new[]
{
new Aws.MediaLive.Inputs.ChannelDestinationSettingArgs
{
Url = $"s3://{main.Id}/test1",
},
new Aws.MediaLive.Inputs.ChannelDestinationSettingArgs
{
Url = $"s3://{main2.Id}/test2",
},
},
Id = "destination",
},
},
InputAttachments = new[]
{
new Aws.MediaLive.Inputs.ChannelInputAttachmentArgs
{
InputAttachmentName = "example-input",
InputId = exampleAwsMedialiveInput.Id,
},
},
Name = "example-channel",
ChannelClass = "STANDARD",
RoleArn = exampleAwsIamRole.Arn,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/medialive"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := medialive.NewChannel(ctx, "example", &medialive.ChannelArgs{
InputSpecification: &medialive.ChannelInputSpecificationArgs{
Codec: pulumi.String("AVC"),
InputResolution: pulumi.String("HD"),
MaximumBitrate: pulumi.String("MAX_20_MBPS"),
},
EncoderSettings: &medialive.ChannelEncoderSettingsArgs{
TimecodeConfig: &medialive.ChannelEncoderSettingsTimecodeConfigArgs{
Source: pulumi.String("EMBEDDED"),
},
AudioDescriptions: medialive.ChannelEncoderSettingsAudioDescriptionArray{
&medialive.ChannelEncoderSettingsAudioDescriptionArgs{
AudioSelectorName: pulumi.String("example audio selector"),
Name: pulumi.String("audio-selector"),
},
},
OutputGroups: medialive.ChannelEncoderSettingsOutputGroupArray{
&medialive.ChannelEncoderSettingsOutputGroupArgs{
OutputGroupSettings: &medialive.ChannelEncoderSettingsOutputGroupOutputGroupSettingsArgs{
ArchiveGroupSettings: medialive.ChannelEncoderSettingsOutputGroupOutputGroupSettingsArchiveGroupSettingArray{
&medialive.ChannelEncoderSettingsOutputGroupOutputGroupSettingsArchiveGroupSettingArgs{
Destination: &medialive.ChannelEncoderSettingsOutputGroupOutputGroupSettingsArchiveGroupSettingDestinationArgs{
DestinationRefId: pulumi.String("destination"),
},
},
},
},
Outputs: medialive.ChannelEncoderSettingsOutputGroupOutputTypeArray{
&medialive.ChannelEncoderSettingsOutputGroupOutputTypeArgs{
OutputSettings: &medialive.ChannelEncoderSettingsOutputGroupOutputOutputSettingsArgs{
ArchiveOutputSettings: &medialive.ChannelEncoderSettingsOutputGroupOutputOutputSettingsArchiveOutputSettingsArgs{
ContainerSettings: &medialive.ChannelEncoderSettingsOutputGroupOutputOutputSettingsArchiveOutputSettingsContainerSettingsArgs{
M2tsSettings: &medialive.ChannelEncoderSettingsOutputGroupOutputOutputSettingsArchiveOutputSettingsContainerSettingsM2tsSettingsArgs{
AudioBufferModel: pulumi.String("ATSC"),
BufferModel: pulumi.String("MULTIPLEX"),
RateMode: pulumi.String("CBR"),
},
},
NameModifier: pulumi.String("_1"),
Extension: pulumi.String("m2ts"),
},
},
OutputName: pulumi.String("example-name"),
VideoDescriptionName: pulumi.String("example-video"),
AudioDescriptionNames: pulumi.StringArray{
pulumi.String("audio-selector"),
},
},
},
},
},
VideoDescriptions: medialive.ChannelEncoderSettingsVideoDescriptionArray{
&medialive.ChannelEncoderSettingsVideoDescriptionArgs{
Name: pulumi.String("example-video"),
},
},
},
Destinations: medialive.ChannelDestinationArray{
&medialive.ChannelDestinationArgs{
Settings: medialive.ChannelDestinationSettingArray{
&medialive.ChannelDestinationSettingArgs{
Url: pulumi.Sprintf("s3://%v/test1", main.Id),
},
&medialive.ChannelDestinationSettingArgs{
Url: pulumi.Sprintf("s3://%v/test2", main2.Id),
},
},
Id: pulumi.String("destination"),
},
},
InputAttachments: medialive.ChannelInputAttachmentArray{
&medialive.ChannelInputAttachmentArgs{
InputAttachmentName: pulumi.String("example-input"),
InputId: pulumi.Any(exampleAwsMedialiveInput.Id),
},
},
Name: pulumi.String("example-channel"),
ChannelClass: pulumi.String("STANDARD"),
RoleArn: pulumi.Any(exampleAwsIamRole.Arn),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_medialive_channel" "example" {
input_specification = {
codec = "AVC"
input_resolution = "HD"
maximum_bitrate = "MAX_20_MBPS"
}
encoder_settings = {
timecode_config = {
source = "EMBEDDED"
}
audio_descriptions = [{
"audioSelectorName" = "example audio selector"
"name" = "audio-selector"
}]
output_groups = [{
"outputGroupSettings" = {
"archiveGroupSettings" = [{
"destination" = {
"destinationRefId" = "destination"
}
}]
}
"outputs" = [{
"outputSettings" = {
"archiveOutputSettings" = {
"containerSettings" = {
"m2tsSettings" = {
"audioBufferModel" = "ATSC"
"bufferModel" = "MULTIPLEX"
"rateMode" = "CBR"
}
}
"nameModifier" = "_1"
"extension" = "m2ts"
}
}
"outputName" = "example-name"
"videoDescriptionName" = "example-video"
"audioDescriptionNames" = ["audio-selector"]
}]
}]
video_descriptions = [{
"name" = "example-video"
}]
}
destinations {
settings {
url ="s3://${main.id}/test1"
}
settings {
url ="s3://${main2.id}/test2"
}
id = "destination"
}
input_attachments {
input_attachment_name = "example-input"
input_id = exampleAwsMedialiveInput.id
}
name = "example-channel"
channel_class = "STANDARD"
role_arn = exampleAwsIamRole.arn
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.medialive.Channel;
import com.pulumi.aws.medialive.ChannelArgs;
import com.pulumi.aws.medialive.inputs.ChannelInputSpecificationArgs;
import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsArgs;
import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsTimecodeConfigArgs;
import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsAudioDescriptionArgs;
import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsOutputGroupArgs;
import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsOutputGroupOutputGroupSettingsArgs;
import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsOutputGroupOutputGroupSettingsArchiveGroupSettingArgs;
import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsOutputGroupOutputGroupSettingsArchiveGroupSettingDestinationArgs;
import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsOutputGroupOutputArgs;
import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsOutputGroupOutputOutputSettingsArgs;
import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsOutputGroupOutputOutputSettingsArchiveOutputSettingsArgs;
import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsOutputGroupOutputOutputSettingsArchiveOutputSettingsContainerSettingsArgs;
import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsOutputGroupOutputOutputSettingsArchiveOutputSettingsContainerSettingsM2tsSettingsArgs;
import com.pulumi.aws.medialive.inputs.ChannelEncoderSettingsVideoDescriptionArgs;
import com.pulumi.aws.medialive.inputs.ChannelDestinationArgs;
import com.pulumi.aws.medialive.inputs.ChannelDestinationSettingArgs;
import com.pulumi.aws.medialive.inputs.ChannelInputAttachmentArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Channel("example", ChannelArgs.builder()
.inputSpecification(ChannelInputSpecificationArgs.builder()
.codec("AVC")
.inputResolution("HD")
.maximumBitrate("MAX_20_MBPS")
.build())
.encoderSettings(ChannelEncoderSettingsArgs.builder()
.timecodeConfig(ChannelEncoderSettingsTimecodeConfigArgs.builder()
.source("EMBEDDED")
.build())
.audioDescriptions(ChannelEncoderSettingsAudioDescriptionArgs.builder()
.audioSelectorName("example audio selector")
.name("audio-selector")
.build())
.outputGroups(ChannelEncoderSettingsOutputGroupArgs.builder()
.outputGroupSettings(ChannelEncoderSettingsOutputGroupOutputGroupSettingsArgs.builder()
.archiveGroupSettings(ChannelEncoderSettingsOutputGroupOutputGroupSettingsArchiveGroupSettingArgs.builder()
.destination(ChannelEncoderSettingsOutputGroupOutputGroupSettingsArchiveGroupSettingDestinationArgs.builder()
.destinationRefId("destination")
.build())
.build())
.build())
.outputs(ChannelEncoderSettingsOutputGroupOutputArgs.builder()
.outputSettings(ChannelEncoderSettingsOutputGroupOutputOutputSettingsArgs.builder()
.archiveOutputSettings(ChannelEncoderSettingsOutputGroupOutputOutputSettingsArchiveOutputSettingsArgs.builder()
.containerSettings(ChannelEncoderSettingsOutputGroupOutputOutputSettingsArchiveOutputSettingsContainerSettingsArgs.builder()
.m2tsSettings(ChannelEncoderSettingsOutputGroupOutputOutputSettingsArchiveOutputSettingsContainerSettingsM2tsSettingsArgs.builder()
.audioBufferModel("ATSC")
.bufferModel("MULTIPLEX")
.rateMode("CBR")
.build())
.build())
.nameModifier("_1")
.extension("m2ts")
.build())
.build())
.outputName("example-name")
.videoDescriptionName("example-video")
.audioDescriptionNames("audio-selector")
.build())
.build())
.videoDescriptions(ChannelEncoderSettingsVideoDescriptionArgs.builder()
.name("example-video")
.build())
.build())
.destinations(ChannelDestinationArgs.builder()
.settings(
ChannelDestinationSettingArgs.builder()
.url(String.format("s3://%s/test1", main.id()))
.build(),
ChannelDestinationSettingArgs.builder()
.url(String.format("s3://%s/test2", main2.id()))
.build())
.id("destination")
.build())
.inputAttachments(ChannelInputAttachmentArgs.builder()
.inputAttachmentName("example-input")
.inputId(exampleAwsMedialiveInput.id())
.build())
.name("example-channel")
.channelClass("STANDARD")
.roleArn(exampleAwsIamRole.arn())
.build());
}
}
resources:
example:
type: aws:medialive:Channel
properties:
inputSpecification:
codec: AVC
inputResolution: HD
maximumBitrate: MAX_20_MBPS
encoderSettings:
timecodeConfig:
source: EMBEDDED
audioDescriptions:
- audioSelectorName: example audio selector
name: audio-selector
outputGroups:
- outputGroupSettings:
archiveGroupSettings:
- destination:
destinationRefId: destination
outputs:
- outputSettings:
archiveOutputSettings:
containerSettings:
m2tsSettings:
audioBufferModel: ATSC
bufferModel: MULTIPLEX
rateMode: CBR
nameModifier: _1
extension: m2ts
outputName: example-name
videoDescriptionName: example-video
audioDescriptionNames:
- audio-selector
videoDescriptions:
- name: example-video
destinations:
- settings:
- url: s3://${main.id}/test1
- url: s3://${main2.id}/test2
id: destination
inputAttachments:
- inputAttachmentName: example-input
inputId: ${exampleAwsMedialiveInput.id}
name: example-channel
channelClass: STANDARD
roleArn: ${exampleAwsIamRole.arn}
Import
Identity Schema
Required
channelId(String) ID of the MediaLive Channel.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import MediaLive Channel using the channelId. For example:
$ pulumi import aws:medialive/channel:Channel example 1234567
Constructors
- Channel(String name, {ChannelArgs? args, CustomResourceOptions? options})
-
Creates a new Channel.
nameThe Pulumi resource name.argsArguments used to configure this Channel. The set of arguments for Channel.optionsResource options controlling this resource's behavior. - Channel.reference(String urn)
- Creates a typed reference to an existing Channel resource.
Properties
-
arn
↔ Output<
String> -
ARN of the Channel.
latefinal
-
cdiInputSpecification
↔ Output<
ChannelCdiInputSpecification?> -
Specification of CDI inputs for this channel. See CDI Input Specification for more details.
latefinal
-
channelClass
↔ Output<
String> -
Concise argument description.
latefinal
-
channelId
↔ Output<
String> -
ID of the Channel.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
destinations
↔ Output<
List< ChannelDestination> > -
Destinations for channel. See Destinations for more details.
latefinal
-
encoderSettings
↔ Output<
ChannelEncoderSettings> -
Encoder settings. See Encoder Settings for more details.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
inputAttachments
↔ Output<
List< ChannelInputAttachment> > -
Input attachments for the channel. See Input Attachments for more details.
latefinal
-
inputSpecification
↔ Output<
ChannelInputSpecification> -
Specification of network and file inputs for the channel.
latefinal
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
logLevel
↔ Output<
String> -
The log level to write to Cloudwatch logs.
latefinal
-
maintenance
↔ Output<
ChannelMaintenance> -
Maintenance settings for this channel. See Maintenance for more details.
latefinal
-
name
↔ Output<
String> -
Name of the Channel.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
roleArn
↔ Output<
String?> -
Concise argument description.
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
startChannel
↔ Output<
bool?> -
Whether to start/stop channel. Default:
falselatefinal -
A map of tags to assign to the channel. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
vpc
↔ Output<
ChannelVpc?> -
Settings for the VPC outputs. See VPC for more details.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited