1. Packages
  2. AWS Native
  3. API Docs
  4. ivs
  5. Channel

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

aws-native.ivs.Channel

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

    Resource Type definition for AWS::IVS::Channel

    Example Usage

    Example

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AwsNative = Pulumi.AwsNative;
    
    return await Deployment.RunAsync(() => 
    {
        var channel = new AwsNative.Ivs.Channel("channel", new()
        {
            Name = "MyChannel",
            Tags = new[]
            {
                new AwsNative.Inputs.TagArgs
                {
                    Key = "MyKey",
                    Value = "MyValue",
                },
            },
            InsecureIngest = true,
        });
    
        var streamKey = new AwsNative.Ivs.StreamKey("streamKey", new()
        {
            ChannelArn = channel.Id,
            Tags = new[]
            {
                new AwsNative.Inputs.TagArgs
                {
                    Key = "MyKey",
                    Value = "MyValue",
                },
            },
        });
    
        return new Dictionary<string, object?>
        {
            ["channelArn"] = channel.Id,
            ["channelIngestEndpoint"] = channel.IngestEndpoint,
            ["channelPlaybackUrl"] = channel.PlaybackUrl,
            ["streamKeyArn"] = streamKey.Id,
        };
    });
    
    package main
    
    import (
    	awsnative "github.com/pulumi/pulumi-aws-native/sdk/go/aws"
    	"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: aws.TagArray{
    				&aws.TagArgs{
    					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: aws.TagArray{
    				&aws.TagArgs{
    					Key:   pulumi.String("MyKey"),
    					Value: pulumi.String("MyValue"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		ctx.Export("channelArn", channel.ID())
    		ctx.Export("channelIngestEndpoint", channel.IngestEndpoint)
    		ctx.Export("channelPlaybackUrl", channel.PlaybackUrl)
    		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.TagArgs(
            key="MyKey",
            value="MyValue",
        )],
        insecure_ingest=True)
    stream_key = aws_native.ivs.StreamKey("streamKey",
        channel_arn=channel.id,
        tags=[aws_native.TagArgs(
            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 System.Linq;
    using Pulumi;
    using AwsNative = Pulumi.AwsNative;
    
    return await Deployment.RunAsync(() => 
    {
        var channel = new AwsNative.Ivs.Channel("channel", new()
        {
            Name = "MyChannel",
            Tags = new[]
            {
                new AwsNative.Inputs.TagArgs
                {
                    Key = "MyKey",
                    Value = "MyValue",
                },
            },
            InsecureIngest = true,
        });
    
        var streamKey = new AwsNative.Ivs.StreamKey("streamKey", new()
        {
            ChannelArn = channel.Id,
            Tags = new[]
            {
                new AwsNative.Inputs.TagArgs
                {
                    Key = "MyKey",
                    Value = "MyValue",
                },
            },
        });
    
        return new Dictionary<string, object?>
        {
            ["channelArn"] = channel.Id,
            ["channelIngestEndpoint"] = channel.IngestEndpoint,
            ["channelPlaybackUrl"] = channel.PlaybackUrl,
            ["streamKeyArn"] = streamKey.Id,
        };
    });
    
    package main
    
    import (
    	awsnative "github.com/pulumi/pulumi-aws-native/sdk/go/aws"
    	"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: aws.TagArray{
    				&aws.TagArgs{
    					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: aws.TagArray{
    				&aws.TagArgs{
    					Key:   pulumi.String("MyKey"),
    					Value: pulumi.String("MyValue"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		ctx.Export("channelArn", channel.ID())
    		ctx.Export("channelIngestEndpoint", channel.IngestEndpoint)
    		ctx.Export("channelPlaybackUrl", channel.PlaybackUrl)
    		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.TagArgs(
            key="MyKey",
            value="MyValue",
        )],
        insecure_ingest=True)
    stream_key = aws_native.ivs.StreamKey("streamKey",
        channel_arn=channel.id,
        tags=[aws_native.TagArgs(
            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

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Channel(name: string, args?: ChannelArgs, opts?: CustomResourceOptions);
    @overload
    def Channel(resource_name: str,
                args: Optional[ChannelArgs] = None,
                opts: Optional[ResourceOptions] = None)
    
    @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,
                preset: Optional[ChannelPreset] = None,
                recording_configuration_arn: Optional[str] = None,
                tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                type: Optional[ChannelType] = 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.
    
    

    Parameters

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const examplechannelResourceResourceFromIvs = new aws_native.ivs.Channel("examplechannelResourceResourceFromIvs", {
        authorized: false,
        insecureIngest: false,
        latencyMode: aws_native.ivs.ChannelLatencyMode.Normal,
        name: "string",
        preset: aws_native.ivs.ChannelPreset.HigherBandwidthDelivery,
        recordingConfigurationArn: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
        type: aws_native.ivs.ChannelType.Standard,
    });
    
    Coming soon!
    

    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
    Preset Pulumi.AwsNative.Ivs.ChannelPreset
    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
    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.Inputs.Tag>
    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
    Preset ChannelPreset
    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
    RecordingConfigurationArn string
    Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
    Tags TagArgs
    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
    preset ChannelPreset
    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
    recordingConfigurationArn String
    Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
    tags List<Tag>
    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
    preset ChannelPreset
    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
    recordingConfigurationArn string
    Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
    tags Tag[]
    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
    preset ChannelPreset
    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
    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[TagArgs]
    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
    preset "HIGHER_BANDWIDTH_DELIVERY" | "CONSTRAINED_BANDWIDTH_DELIVERY"
    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
    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" | "ADVANCED_SD" | "ADVANCED_HD"
    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, ChannelLatencyModeArgs

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

    ChannelPreset, ChannelPresetArgs

    HigherBandwidthDelivery
    HIGHER_BANDWIDTH_DELIVERY
    ConstrainedBandwidthDelivery
    CONSTRAINED_BANDWIDTH_DELIVERY
    ChannelPresetHigherBandwidthDelivery
    HIGHER_BANDWIDTH_DELIVERY
    ChannelPresetConstrainedBandwidthDelivery
    CONSTRAINED_BANDWIDTH_DELIVERY
    HigherBandwidthDelivery
    HIGHER_BANDWIDTH_DELIVERY
    ConstrainedBandwidthDelivery
    CONSTRAINED_BANDWIDTH_DELIVERY
    HigherBandwidthDelivery
    HIGHER_BANDWIDTH_DELIVERY
    ConstrainedBandwidthDelivery
    CONSTRAINED_BANDWIDTH_DELIVERY
    HIGHER_BANDWIDTH_DELIVERY
    HIGHER_BANDWIDTH_DELIVERY
    CONSTRAINED_BANDWIDTH_DELIVERY
    CONSTRAINED_BANDWIDTH_DELIVERY
    "HIGHER_BANDWIDTH_DELIVERY"
    HIGHER_BANDWIDTH_DELIVERY
    "CONSTRAINED_BANDWIDTH_DELIVERY"
    CONSTRAINED_BANDWIDTH_DELIVERY

    ChannelType, ChannelTypeArgs

    Standard
    STANDARD
    Basic
    BASIC
    AdvancedSd
    ADVANCED_SD
    AdvancedHd
    ADVANCED_HD
    ChannelTypeStandard
    STANDARD
    ChannelTypeBasic
    BASIC
    ChannelTypeAdvancedSd
    ADVANCED_SD
    ChannelTypeAdvancedHd
    ADVANCED_HD
    Standard
    STANDARD
    Basic
    BASIC
    AdvancedSd
    ADVANCED_SD
    AdvancedHd
    ADVANCED_HD
    Standard
    STANDARD
    Basic
    BASIC
    AdvancedSd
    ADVANCED_SD
    AdvancedHd
    ADVANCED_HD
    STANDARD
    STANDARD
    BASIC
    BASIC
    ADVANCED_SD
    ADVANCED_SD
    ADVANCED_HD
    ADVANCED_HD
    "STANDARD"
    STANDARD
    "BASIC"
    BASIC
    "ADVANCED_SD"
    ADVANCED_SD
    "ADVANCED_HD"
    ADVANCED_HD

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi