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

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

aws.ivs.Channel

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    Resource for managing an AWS IVS (Interactive Video) Channel.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.ivs.Channel("example", {name: "channel-1"});
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.ivs.Channel("example", name="channel-1")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ivs"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ivs.NewChannel(ctx, "example", &ivs.ChannelArgs{
    			Name: pulumi.String("channel-1"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Ivs.Channel("example", new()
        {
            Name = "channel-1",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.ivs.Channel;
    import com.pulumi.aws.ivs.ChannelArgs;
    import java.util.List;
    import java.util.ArrayList;
    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()
                .name("channel-1")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:ivs:Channel
        properties:
          name: channel-1
    

    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,
                latency_mode: Optional[str] = None,
                name: Optional[str] = None,
                recording_configuration_arn: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                type: Optional[str] = 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: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.

    var channelResource = new Aws.Ivs.Channel("channelResource", new()
    {
        Authorized = false,
        LatencyMode = "string",
        Name = "string",
        RecordingConfigurationArn = "string",
        Tags = 
        {
            { "string", "string" },
        },
        Type = "string",
    });
    
    example, err := ivs.NewChannel(ctx, "channelResource", &ivs.ChannelArgs{
    	Authorized:                pulumi.Bool(false),
    	LatencyMode:               pulumi.String("string"),
    	Name:                      pulumi.String("string"),
    	RecordingConfigurationArn: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Type: pulumi.String("string"),
    })
    
    var channelResource = new Channel("channelResource", ChannelArgs.builder()
        .authorized(false)
        .latencyMode("string")
        .name("string")
        .recordingConfigurationArn("string")
        .tags(Map.of("string", "string"))
        .type("string")
        .build());
    
    channel_resource = aws.ivs.Channel("channelResource",
        authorized=False,
        latency_mode="string",
        name="string",
        recording_configuration_arn="string",
        tags={
            "string": "string",
        },
        type="string")
    
    const channelResource = new aws.ivs.Channel("channelResource", {
        authorized: false,
        latencyMode: "string",
        name: "string",
        recordingConfigurationArn: "string",
        tags: {
            string: "string",
        },
        type: "string",
    });
    
    type: aws:ivs:Channel
    properties:
        authorized: false
        latencyMode: string
        name: string
        recordingConfigurationArn: string
        tags:
            string: string
        type: string
    

    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
    If true, channel is private (enabled for playback authorization).
    LatencyMode string
    Channel latency mode. Valid values: NORMAL, LOW.
    Name string
    Channel name.
    RecordingConfigurationArn string
    Recording configuration ARN.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Type string
    Channel type, which determines the allowable resolution and bitrate. Valid values: STANDARD, BASIC.
    Authorized bool
    If true, channel is private (enabled for playback authorization).
    LatencyMode string
    Channel latency mode. Valid values: NORMAL, LOW.
    Name string
    Channel name.
    RecordingConfigurationArn string
    Recording configuration ARN.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Type string
    Channel type, which determines the allowable resolution and bitrate. Valid values: STANDARD, BASIC.
    authorized Boolean
    If true, channel is private (enabled for playback authorization).
    latencyMode String
    Channel latency mode. Valid values: NORMAL, LOW.
    name String
    Channel name.
    recordingConfigurationArn String
    Recording configuration ARN.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    type String
    Channel type, which determines the allowable resolution and bitrate. Valid values: STANDARD, BASIC.
    authorized boolean
    If true, channel is private (enabled for playback authorization).
    latencyMode string
    Channel latency mode. Valid values: NORMAL, LOW.
    name string
    Channel name.
    recordingConfigurationArn string
    Recording configuration ARN.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    type string
    Channel type, which determines the allowable resolution and bitrate. Valid values: STANDARD, BASIC.
    authorized bool
    If true, channel is private (enabled for playback authorization).
    latency_mode str
    Channel latency mode. Valid values: NORMAL, LOW.
    name str
    Channel name.
    recording_configuration_arn str
    Recording configuration ARN.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    type str
    Channel type, which determines the allowable resolution and bitrate. Valid values: STANDARD, BASIC.
    authorized Boolean
    If true, channel is private (enabled for playback authorization).
    latencyMode String
    Channel latency mode. Valid values: NORMAL, LOW.
    name String
    Channel name.
    recordingConfigurationArn String
    Recording configuration ARN.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    type String
    Channel type, which determines the allowable resolution and bitrate. Valid values: STANDARD, BASIC.

    Outputs

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

    Arn string
    ARN of the Channel.
    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 setting up streaming software.
    PlaybackUrl string
    Channel playback URL.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the Channel.
    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 setting up streaming software.
    PlaybackUrl string
    Channel playback URL.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Channel.
    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 setting up streaming software.
    playbackUrl String
    Channel playback URL.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the Channel.
    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 setting up streaming software.
    playbackUrl string
    Channel playback URL.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the Channel.
    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 setting up streaming software.
    playback_url str
    Channel playback URL.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Channel.
    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 setting up streaming software.
    playbackUrl String
    Channel playback URL.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Channel Resource

    Get an existing Channel resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ChannelState, opts?: CustomResourceOptions): Channel
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            authorized: Optional[bool] = None,
            ingest_endpoint: Optional[str] = None,
            latency_mode: Optional[str] = None,
            name: Optional[str] = None,
            playback_url: Optional[str] = None,
            recording_configuration_arn: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            type: Optional[str] = None) -> Channel
    func GetChannel(ctx *Context, name string, id IDInput, state *ChannelState, opts ...ResourceOption) (*Channel, error)
    public static Channel Get(string name, Input<string> id, ChannelState? state, CustomResourceOptions? opts = null)
    public static Channel get(String name, Output<String> id, ChannelState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the Channel.
    Authorized bool
    If true, channel is private (enabled for playback authorization).
    IngestEndpoint string
    Channel ingest endpoint, part of the definition of an ingest server, used when setting up streaming software.
    LatencyMode string
    Channel latency mode. Valid values: NORMAL, LOW.
    Name string
    Channel name.
    PlaybackUrl string
    Channel playback URL.
    RecordingConfigurationArn string
    Recording configuration ARN.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Type string
    Channel type, which determines the allowable resolution and bitrate. Valid values: STANDARD, BASIC.
    Arn string
    ARN of the Channel.
    Authorized bool
    If true, channel is private (enabled for playback authorization).
    IngestEndpoint string
    Channel ingest endpoint, part of the definition of an ingest server, used when setting up streaming software.
    LatencyMode string
    Channel latency mode. Valid values: NORMAL, LOW.
    Name string
    Channel name.
    PlaybackUrl string
    Channel playback URL.
    RecordingConfigurationArn string
    Recording configuration ARN.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Type string
    Channel type, which determines the allowable resolution and bitrate. Valid values: STANDARD, BASIC.
    arn String
    ARN of the Channel.
    authorized Boolean
    If true, channel is private (enabled for playback authorization).
    ingestEndpoint String
    Channel ingest endpoint, part of the definition of an ingest server, used when setting up streaming software.
    latencyMode String
    Channel latency mode. Valid values: NORMAL, LOW.
    name String
    Channel name.
    playbackUrl String
    Channel playback URL.
    recordingConfigurationArn String
    Recording configuration ARN.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type String
    Channel type, which determines the allowable resolution and bitrate. Valid values: STANDARD, BASIC.
    arn string
    ARN of the Channel.
    authorized boolean
    If true, channel is private (enabled for playback authorization).
    ingestEndpoint string
    Channel ingest endpoint, part of the definition of an ingest server, used when setting up streaming software.
    latencyMode string
    Channel latency mode. Valid values: NORMAL, LOW.
    name string
    Channel name.
    playbackUrl string
    Channel playback URL.
    recordingConfigurationArn string
    Recording configuration ARN.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type string
    Channel type, which determines the allowable resolution and bitrate. Valid values: STANDARD, BASIC.
    arn str
    ARN of the Channel.
    authorized bool
    If true, channel is private (enabled for playback authorization).
    ingest_endpoint str
    Channel ingest endpoint, part of the definition of an ingest server, used when setting up streaming software.
    latency_mode str
    Channel latency mode. Valid values: NORMAL, LOW.
    name str
    Channel name.
    playback_url str
    Channel playback URL.
    recording_configuration_arn str
    Recording configuration ARN.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type str
    Channel type, which determines the allowable resolution and bitrate. Valid values: STANDARD, BASIC.
    arn String
    ARN of the Channel.
    authorized Boolean
    If true, channel is private (enabled for playback authorization).
    ingestEndpoint String
    Channel ingest endpoint, part of the definition of an ingest server, used when setting up streaming software.
    latencyMode String
    Channel latency mode. Valid values: NORMAL, LOW.
    name String
    Channel name.
    playbackUrl String
    Channel playback URL.
    recordingConfigurationArn String
    Recording configuration ARN.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type String
    Channel type, which determines the allowable resolution and bitrate. Valid values: STANDARD, BASIC.

    Import

    Using pulumi import, import IVS (Interactive Video) Channel using the ARN. For example:

    $ pulumi import aws:ivs/channel:Channel example arn:aws:ivs:us-west-2:326937407773:channel/0Y1lcs4U7jk5
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi