1. Packages
  2. AWS
  3. API Docs
  4. mediapackagev2
  5. ChannelGroup
AWS v6.67.0 published on Tuesday, Jan 21, 2025 by Pulumi

aws.mediapackagev2.ChannelGroup

Explore with Pulumi AI

aws logo
AWS v6.67.0 published on Tuesday, Jan 21, 2025 by Pulumi

    Creates an AWS Elemental MediaPackage Version 2 Channel Group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.mediapackagev2.ChannelGroup("example", {
        name: "example",
        description: "channel group for example channels",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.mediapackagev2.ChannelGroup("example",
        name="example",
        description="channel group for example channels")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/mediapackagev2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := mediapackagev2.NewChannelGroup(ctx, "example", &mediapackagev2.ChannelGroupArgs{
    			Name:        pulumi.String("example"),
    			Description: pulumi.String("channel group for example channels"),
    		})
    		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.MediaPackageV2.ChannelGroup("example", new()
        {
            Name = "example",
            Description = "channel group for example channels",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.mediapackagev2.ChannelGroup;
    import com.pulumi.aws.mediapackagev2.ChannelGroupArgs;
    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 ChannelGroup("example", ChannelGroupArgs.builder()
                .name("example")
                .description("channel group for example channels")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:mediapackagev2:ChannelGroup
        properties:
          name: example
          description: channel group for example channels
    

    Create ChannelGroup Resource

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

    Constructor syntax

    new ChannelGroup(name: string, args?: ChannelGroupArgs, opts?: CustomResourceOptions);
    @overload
    def ChannelGroup(resource_name: str,
                     args: Optional[ChannelGroupArgs] = None,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def ChannelGroup(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     description: Optional[str] = None,
                     name: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None)
    func NewChannelGroup(ctx *Context, name string, args *ChannelGroupArgs, opts ...ResourceOption) (*ChannelGroup, error)
    public ChannelGroup(string name, ChannelGroupArgs? args = null, CustomResourceOptions? opts = null)
    public ChannelGroup(String name, ChannelGroupArgs args)
    public ChannelGroup(String name, ChannelGroupArgs args, CustomResourceOptions options)
    
    type: aws:mediapackagev2:ChannelGroup
    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 ChannelGroupArgs
    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 ChannelGroupArgs
    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 ChannelGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ChannelGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ChannelGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var channelGroupResource = new Aws.MediaPackageV2.ChannelGroup("channelGroupResource", new()
    {
        Description = "string",
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := mediapackagev2.NewChannelGroup(ctx, "channelGroupResource", &mediapackagev2.ChannelGroupArgs{
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var channelGroupResource = new ChannelGroup("channelGroupResource", ChannelGroupArgs.builder()
        .description("string")
        .name("string")
        .tags(Map.of("string", "string"))
        .build());
    
    channel_group_resource = aws.mediapackagev2.ChannelGroup("channelGroupResource",
        description="string",
        name="string",
        tags={
            "string": "string",
        })
    
    const channelGroupResource = new aws.mediapackagev2.ChannelGroup("channelGroupResource", {
        description: "string",
        name: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:mediapackagev2:ChannelGroup
    properties:
        description: string
        name: string
        tags:
            string: string
    

    ChannelGroup Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ChannelGroup resource accepts the following input properties:

    Description string
    A description of the channel group
    Name string
    A unique identifier naming the channel group
    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.
    Description string
    A description of the channel group
    Name string
    A unique identifier naming the channel group
    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.
    description String
    A description of the channel group
    name String
    A unique identifier naming the channel group
    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.
    description string
    A description of the channel group
    name string
    A unique identifier naming the channel group
    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.
    description str
    A description of the channel group
    name str
    A unique identifier naming the channel group
    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.
    description String
    A description of the channel group
    name String
    A unique identifier naming the channel group
    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 ChannelGroup resource produces the following output properties:

    Arn string
    The ARN of the channel
    EgressDomain string
    The egress domain of the channel group
    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
    EgressDomain string
    The egress domain of the channel group
    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
    egressDomain String
    The egress domain of the channel group
    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
    egressDomain string
    The egress domain of the channel group
    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
    egress_domain str
    The egress domain of the channel group
    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
    egressDomain String
    The egress domain of the channel group
    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 ChannelGroup Resource

    Get an existing ChannelGroup 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?: ChannelGroupState, opts?: CustomResourceOptions): ChannelGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            description: Optional[str] = None,
            egress_domain: Optional[str] = None,
            name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> ChannelGroup
    func GetChannelGroup(ctx *Context, name string, id IDInput, state *ChannelGroupState, opts ...ResourceOption) (*ChannelGroup, error)
    public static ChannelGroup Get(string name, Input<string> id, ChannelGroupState? state, CustomResourceOptions? opts = null)
    public static ChannelGroup get(String name, Output<String> id, ChannelGroupState state, CustomResourceOptions options)
    resources:  _:    type: aws:mediapackagev2:ChannelGroup    get:      id: ${id}
    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
    Description string
    A description of the channel group
    EgressDomain string
    The egress domain of the channel group
    Name string
    A unique identifier naming the channel group
    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
    Description string
    A description of the channel group
    EgressDomain string
    The egress domain of the channel group
    Name string
    A unique identifier naming the channel group
    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
    description String
    A description of the channel group
    egressDomain String
    The egress domain of the channel group
    name String
    A unique identifier naming the channel group
    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
    description string
    A description of the channel group
    egressDomain string
    The egress domain of the channel group
    name string
    A unique identifier naming the channel group
    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
    description str
    A description of the channel group
    egress_domain str
    The egress domain of the channel group
    name str
    A unique identifier naming the channel group
    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
    description String
    A description of the channel group
    egressDomain String
    The egress domain of the channel group
    name String
    A unique identifier naming the channel group
    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.

    Import

    Using pulumi import, import Elemental MediaPackage Version 2 Channel Group using the channel group’s name. For example:

    $ pulumi import aws:mediapackagev2/channelGroup:ChannelGroup example example
    

    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
    AWS v6.67.0 published on Tuesday, Jan 21, 2025 by Pulumi