Docs Packages
  1. Pulumi Registry
  2. AWS Native
  3. API Docs
  4. ivs
  5. Channel
aws-native logo
AWS Native v0.63.0, May 25 23

aws-native.ivs.Channel

Explore with Pulumi AI

Resource Type definition for AWS::IVS::Channel

Example Usage

Example

using System.Collections.Generic;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var channel = new AwsNative.IVS.Channel("channel", new()
    {
        Name = "MyChannel",
        Tags = new[]
        {
            new AwsNative.IVS.Inputs.ChannelTagArgs
            {
                Key = "MyKey",
                Value = "MyValue",
            },
        },
        InsecureIngest = true,
    });

    var streamKey = new AwsNative.IVS.StreamKey("streamKey", new()
    {
        ChannelArn = channel.Id,
        Tags = new[]
        {
            new AwsNative.IVS.Inputs.StreamKeyTagArgs
            {
                Key = "MyKey",
                Value = "MyValue",
            },
        },
    });

    return new Dictionary<string, object?>
    {
        ["channelArn"] = channel.Id,
        ["channelIngestEndpoint"] = channel.Ingest_endpoint,
        ["channelPlaybackUrl"] = channel.Playback_url,
        ["streamKeyArn"] = streamKey.Id,
    };
});

package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/ivs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		channel, err := ivs.NewChannel(ctx, "channel", &ivs.ChannelArgs{
			Name: pulumi.String("MyChannel"),
			Tags: []ivs.ChannelTagArgs{
				{
					Key:   pulumi.String("MyKey"),
					Value: pulumi.String("MyValue"),
				},
			},
			InsecureIngest: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		streamKey, err := ivs.NewStreamKey(ctx, "streamKey", &ivs.StreamKeyArgs{
			ChannelArn: channel.ID(),
			Tags: []ivs.StreamKeyTagArgs{
				{
					Key:   pulumi.String("MyKey"),
					Value: pulumi.String("MyValue"),
				},
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("channelArn", channel.ID())
		ctx.Export("channelIngestEndpoint", channel.Ingest_endpoint)
		ctx.Export("channelPlaybackUrl", channel.Playback_url)
		ctx.Export("streamKeyArn", streamKey.ID())
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_aws_native as aws_native

channel = aws_native.ivs.Channel("channel",
    name="MyChannel",
    tags=[aws_native.ivs.ChannelTagArgs(
        key="MyKey",
        value="MyValue",
    )],
    insecure_ingest=True)
stream_key = aws_native.ivs.StreamKey("streamKey",
    channel_arn=channel.id,
    tags=[aws_native.ivs.StreamKeyTagArgs(
        key="MyKey",
        value="MyValue",
    )])
pulumi.export("channelArn", channel.id)
pulumi.export("channelIngestEndpoint", channel.ingest_endpoint)
pulumi.export("channelPlaybackUrl", channel.playback_url)
pulumi.export("streamKeyArn", stream_key.id)

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const channel = new aws_native.ivs.Channel("channel", {
    name: "MyChannel",
    tags: [{
        key: "MyKey",
        value: "MyValue",
    }],
    insecureIngest: true,
});
const streamKey = new aws_native.ivs.StreamKey("streamKey", {
    channelArn: channel.id,
    tags: [{
        key: "MyKey",
        value: "MyValue",
    }],
});
export const channelArn = channel.id;
export const channelIngestEndpoint = channel.ingestEndpoint;
export const channelPlaybackUrl = channel.playbackUrl;
export const streamKeyArn = streamKey.id;

Coming soon!

Example

using System.Collections.Generic;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var channel = new AwsNative.IVS.Channel("channel", new()
    {
        Name = "MyChannel",
        Tags = new[]
        {
            new AwsNative.IVS.Inputs.ChannelTagArgs
            {
                Key = "MyKey",
                Value = "MyValue",
            },
        },
        InsecureIngest = true,
    });

    var streamKey = new AwsNative.IVS.StreamKey("streamKey", new()
    {
        ChannelArn = channel.Id,
        Tags = new[]
        {
            new AwsNative.IVS.Inputs.StreamKeyTagArgs
            {
                Key = "MyKey",
                Value = "MyValue",
            },
        },
    });

    return new Dictionary<string, object?>
    {
        ["channelArn"] = channel.Id,
        ["channelIngestEndpoint"] = channel.Ingest_endpoint,
        ["channelPlaybackUrl"] = channel.Playback_url,
        ["streamKeyArn"] = streamKey.Id,
    };
});

package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/ivs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		channel, err := ivs.NewChannel(ctx, "channel", &ivs.ChannelArgs{
			Name: pulumi.String("MyChannel"),
			Tags: []ivs.ChannelTagArgs{
				{
					Key:   pulumi.String("MyKey"),
					Value: pulumi.String("MyValue"),
				},
			},
			InsecureIngest: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		streamKey, err := ivs.NewStreamKey(ctx, "streamKey", &ivs.StreamKeyArgs{
			ChannelArn: channel.ID(),
			Tags: []ivs.StreamKeyTagArgs{
				{
					Key:   pulumi.String("MyKey"),
					Value: pulumi.String("MyValue"),
				},
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("channelArn", channel.ID())
		ctx.Export("channelIngestEndpoint", channel.Ingest_endpoint)
		ctx.Export("channelPlaybackUrl", channel.Playback_url)
		ctx.Export("streamKeyArn", streamKey.ID())
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_aws_native as aws_native

channel = aws_native.ivs.Channel("channel",
    name="MyChannel",
    tags=[aws_native.ivs.ChannelTagArgs(
        key="MyKey",
        value="MyValue",
    )],
    insecure_ingest=True)
stream_key = aws_native.ivs.StreamKey("streamKey",
    channel_arn=channel.id,
    tags=[aws_native.ivs.StreamKeyTagArgs(
        key="MyKey",
        value="MyValue",
    )])
pulumi.export("channelArn", channel.id)
pulumi.export("channelIngestEndpoint", channel.ingest_endpoint)
pulumi.export("channelPlaybackUrl", channel.playback_url)
pulumi.export("streamKeyArn", stream_key.id)

import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const channel = new aws_native.ivs.Channel("channel", {
    name: "MyChannel",
    tags: [{
        key: "MyKey",
        value: "MyValue",
    }],
    insecureIngest: true,
});
const streamKey = new aws_native.ivs.StreamKey("streamKey", {
    channelArn: channel.id,
    tags: [{
        key: "MyKey",
        value: "MyValue",
    }],
});
export const channelArn = channel.id;
export const channelIngestEndpoint = channel.ingestEndpoint;
export const channelPlaybackUrl = channel.playbackUrl;
export const streamKeyArn = streamKey.id;

Coming soon!

Create Channel Resource

new Channel(name: string, args?: ChannelArgs, opts?: CustomResourceOptions);
@overload
def Channel(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            authorized: Optional[bool] = None,
            insecure_ingest: Optional[bool] = None,
            latency_mode: Optional[ChannelLatencyMode] = None,
            name: Optional[str] = None,
            recording_configuration_arn: Optional[str] = None,
            tags: Optional[Sequence[ChannelTagArgs]] = None,
            type: Optional[ChannelType] = None)
@overload
def Channel(resource_name: str,
            args: Optional[ChannelArgs] = None,
            opts: Optional[ResourceOptions] = None)
func NewChannel(ctx *Context, name string, args *ChannelArgs, opts ...ResourceOption) (*Channel, error)
public Channel(string name, ChannelArgs? args = null, CustomResourceOptions? opts = null)
public Channel(String name, ChannelArgs args)
public Channel(String name, ChannelArgs args, CustomResourceOptions options)

type: aws-native:ivs:Channel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ChannelArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args ChannelArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ChannelArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ChannelArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ChannelArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Channel Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Channel resource accepts the following input properties:

Authorized bool

Whether the channel is authorized.

InsecureIngest bool

Whether the channel allows insecure ingest.

LatencyMode Pulumi.AwsNative.IVS.ChannelLatencyMode

Channel latency mode.

Name string

Channel

RecordingConfigurationArn string

Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).

Tags List<Pulumi.AwsNative.IVS.Inputs.ChannelTagArgs>

A list of key-value pairs that contain metadata for the asset model.

Type Pulumi.AwsNative.IVS.ChannelType

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.

Authorized bool

Whether the channel is authorized.

InsecureIngest bool

Whether the channel allows insecure ingest.

LatencyMode ChannelLatencyMode

Channel latency mode.

Name string

Channel

RecordingConfigurationArn string

Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).

Tags []ChannelTagArgs

A list of key-value pairs that contain metadata for the asset model.

Type ChannelType

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.

authorized Boolean

Whether the channel is authorized.

insecureIngest Boolean

Whether the channel allows insecure ingest.

latencyMode ChannelLatencyMode

Channel latency mode.

name String

Channel

recordingConfigurationArn String

Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).

tags List<ChannelTagArgs>

A list of key-value pairs that contain metadata for the asset model.

type ChannelType

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.

authorized boolean

Whether the channel is authorized.

insecureIngest boolean

Whether the channel allows insecure ingest.

latencyMode ChannelLatencyMode

Channel latency mode.

name string

Channel

recordingConfigurationArn string

Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).

tags ChannelTagArgs[]

A list of key-value pairs that contain metadata for the asset model.

type ChannelType

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.

authorized bool

Whether the channel is authorized.

insecure_ingest bool

Whether the channel allows insecure ingest.

latency_mode ChannelLatencyMode

Channel latency mode.

name str

Channel

recording_configuration_arn str

Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).

tags Sequence[ChannelTagArgs]

A list of key-value pairs that contain metadata for the asset model.

type ChannelType

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.

authorized Boolean

Whether the channel is authorized.

insecureIngest Boolean

Whether the channel allows insecure ingest.

latencyMode "NORMAL" | "LOW"

Channel latency mode.

name String

Channel

recordingConfigurationArn String

Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).

tags List<Property Map>

A list of key-value pairs that contain metadata for the asset model.

type "STANDARD" | "BASIC"

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.

Outputs

All input properties are implicitly available as output properties. Additionally, the Channel resource produces the following output properties:

Arn string

Channel ARN is automatically generated on creation and assigned as the unique identifier.

Id string

The provider-assigned unique ID for this managed resource.

IngestEndpoint string

Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

PlaybackUrl string

Channel Playback URL.

Arn string

Channel ARN is automatically generated on creation and assigned as the unique identifier.

Id string

The provider-assigned unique ID for this managed resource.

IngestEndpoint string

Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

PlaybackUrl string

Channel Playback URL.

arn String

Channel ARN is automatically generated on creation and assigned as the unique identifier.

id String

The provider-assigned unique ID for this managed resource.

ingestEndpoint String

Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

playbackUrl String

Channel Playback URL.

arn string

Channel ARN is automatically generated on creation and assigned as the unique identifier.

id string

The provider-assigned unique ID for this managed resource.

ingestEndpoint string

Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

playbackUrl string

Channel Playback URL.

arn str

Channel ARN is automatically generated on creation and assigned as the unique identifier.

id str

The provider-assigned unique ID for this managed resource.

ingest_endpoint str

Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

playback_url str

Channel Playback URL.

arn String

Channel ARN is automatically generated on creation and assigned as the unique identifier.

id String

The provider-assigned unique ID for this managed resource.

ingestEndpoint String

Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

playbackUrl String

Channel Playback URL.

Supporting Types

ChannelLatencyMode

Normal
NORMAL
Low
LOW
ChannelLatencyModeNormal
NORMAL
ChannelLatencyModeLow
LOW
Normal
NORMAL
Low
LOW
Normal
NORMAL
Low
LOW
NORMAL
NORMAL
LOW
LOW
"NORMAL"
NORMAL
"LOW"
LOW

ChannelTag

Key string
Value string
Key string
Value string
key String
value String
key string
value string
key str
value str
key String
value String

ChannelType

Standard
STANDARD
Basic
BASIC
ChannelTypeStandard
STANDARD
ChannelTypeBasic
BASIC
Standard
STANDARD
Basic
BASIC
Standard
STANDARD
Basic
BASIC
STANDARD
STANDARD
BASIC
BASIC
"STANDARD"
STANDARD
"BASIC"
BASIC

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0