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

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

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

aws.mediapackage.Channel

Explore with Pulumi AI

aws logo

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

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

    Provides an AWS Elemental MediaPackage Channel.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const kittens = new aws.mediapackage.Channel("kittens", {
        channelId: "kitten-channel",
        description: "A channel dedicated to amusing videos of kittens.",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    kittens = aws.mediapackage.Channel("kittens",
        channel_id="kitten-channel",
        description="A channel dedicated to amusing videos of kittens.")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/mediapackage"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := mediapackage.NewChannel(ctx, "kittens", &mediapackage.ChannelArgs{
    			ChannelId:   pulumi.String("kitten-channel"),
    			Description: pulumi.String("A channel dedicated to amusing videos of kittens."),
    		})
    		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 kittens = new Aws.MediaPackage.Channel("kittens", new()
        {
            ChannelId = "kitten-channel",
            Description = "A channel dedicated to amusing videos of kittens.",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.mediapackage.Channel;
    import com.pulumi.aws.mediapackage.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 kittens = new Channel("kittens", ChannelArgs.builder()
                .channelId("kitten-channel")
                .description("A channel dedicated to amusing videos of kittens.")
                .build());
    
        }
    }
    
    resources:
      kittens:
        type: aws:mediapackage:Channel
        properties:
          channelId: kitten-channel
          description: A channel dedicated to amusing videos of kittens.
    

    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: ChannelArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Channel(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                channel_id: Optional[str] = None,
                description: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None)
    func NewChannel(ctx *Context, name string, args ChannelArgs, opts ...ResourceOption) (*Channel, error)
    public Channel(string name, ChannelArgs args, CustomResourceOptions? opts = null)
    public Channel(String name, ChannelArgs args)
    public Channel(String name, ChannelArgs args, CustomResourceOptions options)
    
    type: aws:mediapackage: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 examplechannelResourceResourceFromMediapackagechannel = new Aws.MediaPackage.Channel("examplechannelResourceResourceFromMediapackagechannel", new()
    {
        ChannelId = "string",
        Description = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := mediapackage.NewChannel(ctx, "examplechannelResourceResourceFromMediapackagechannel", &mediapackage.ChannelArgs{
    	ChannelId:   pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var examplechannelResourceResourceFromMediapackagechannel = new Channel("examplechannelResourceResourceFromMediapackagechannel", ChannelArgs.builder()
        .channelId("string")
        .description("string")
        .tags(Map.of("string", "string"))
        .build());
    
    examplechannel_resource_resource_from_mediapackagechannel = aws.mediapackage.Channel("examplechannelResourceResourceFromMediapackagechannel",
        channel_id="string",
        description="string",
        tags={
            "string": "string",
        })
    
    const examplechannelResourceResourceFromMediapackagechannel = new aws.mediapackage.Channel("examplechannelResourceResourceFromMediapackagechannel", {
        channelId: "string",
        description: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:mediapackage:Channel
    properties:
        channelId: string
        description: string
        tags:
            string: 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:

    ChannelId string
    A unique identifier describing the channel
    Description string
    A description of the channel
    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.
    ChannelId string
    A unique identifier describing the channel
    Description string
    A description of the channel
    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.
    channelId String
    A unique identifier describing the channel
    description String
    A description of the channel
    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.
    channelId string
    A unique identifier describing the channel
    description string
    A description of the channel
    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.
    channel_id str
    A unique identifier describing the channel
    description str
    A description of the channel
    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.
    channelId String
    A unique identifier describing the channel
    description String
    A description of the channel
    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.

    Outputs

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

    Arn string
    The ARN of the channel
    HlsIngests List<ChannelHlsIngest>
    A single item list of HLS ingest information
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The ARN of the channel
    HlsIngests []ChannelHlsIngest
    A single item list of HLS ingest information
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the channel
    hlsIngests List<ChannelHlsIngest>
    A single item list of HLS ingest information
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The ARN of the channel
    hlsIngests ChannelHlsIngest[]
    A single item list of HLS ingest information
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The ARN of the channel
    hls_ingests Sequence[ChannelHlsIngest]
    A single item list of HLS ingest information
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the channel
    hlsIngests List<Property Map>
    A single item list of HLS ingest information
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A 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,
            channel_id: Optional[str] = None,
            description: Optional[str] = None,
            hls_ingests: Optional[Sequence[ChannelHlsIngestArgs]] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, 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
    The ARN of the channel
    ChannelId string
    A unique identifier describing the channel
    Description string
    A description of the channel
    HlsIngests List<ChannelHlsIngest>
    A single item list of HLS ingest information
    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>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The ARN of the channel
    ChannelId string
    A unique identifier describing the channel
    Description string
    A description of the channel
    HlsIngests []ChannelHlsIngestArgs
    A single item list of HLS ingest information
    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
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the channel
    channelId String
    A unique identifier describing the channel
    description String
    A description of the channel
    hlsIngests List<ChannelHlsIngest>
    A single item list of HLS ingest information
    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>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The ARN of the channel
    channelId string
    A unique identifier describing the channel
    description string
    A description of the channel
    hlsIngests ChannelHlsIngest[]
    A single item list of HLS ingest information
    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}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The ARN of the channel
    channel_id str
    A unique identifier describing the channel
    description str
    A description of the channel
    hls_ingests Sequence[ChannelHlsIngestArgs]
    A single item list of HLS ingest information
    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]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the channel
    channelId String
    A unique identifier describing the channel
    description String
    A description of the channel
    hlsIngests List<Property Map>
    A single item list of HLS ingest information
    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>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    ChannelHlsIngest, ChannelHlsIngestArgs

    ingestEndpoints List<Property Map>
    A list of the ingest endpoints

    ChannelHlsIngestIngestEndpoint, ChannelHlsIngestIngestEndpointArgs

    Password string
    The password
    Url string
    The URL
    Username string
    The username
    Password string
    The password
    Url string
    The URL
    Username string
    The username
    password String
    The password
    url String
    The URL
    username String
    The username
    password string
    The password
    url string
    The URL
    username string
    The username
    password str
    The password
    url str
    The URL
    username str
    The username
    password String
    The password
    url String
    The URL
    username String
    The username

    Import

    Using pulumi import, import Media Package Channels using the channel ID. For example:

    $ pulumi import aws:mediapackage/channel:Channel kittens kittens-channel
    

    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.41.0 published on Tuesday, Jun 18, 2024 by Pulumi