Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. mediapackagev2
  5. Channel

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.mediapackagev2.Channel

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Represents an entry point into AWS Elemental MediaPackage for an ABR video content stream sent from an upstream encoder such as AWS Elemental MediaLive. The channel continuously analyzes the content that it receives and prepares it to be distributed to consumers via one or more origin endpoints.

    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_group_name: Optional[str] = None,
            channel_name: Optional[str] = None,
            description: Optional[str] = None,
            input_switch_configuration: Optional[ChannelInputSwitchConfigurationArgs] = None,
            input_type: Optional[ChannelInputType] = None,
            output_header_configuration: Optional[ChannelOutputHeaderConfigurationArgs] = None,
            tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native:mediapackagev2: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.

    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

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

    The Channel resource accepts the following input properties:

    ChannelGroupName string
    The name of the channel group associated with the channel configuration.
    ChannelName string
    The name of the channel.
    Description string
    InputSwitchConfiguration Pulumi.AwsNative.MediaPackageV2.Inputs.ChannelInputSwitchConfiguration
    The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive.
    InputType Pulumi.AwsNative.MediaPackageV2.ChannelInputType

    The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

    The allowed values are:

    • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
    • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
    OutputHeaderConfiguration Pulumi.AwsNative.MediaPackageV2.Inputs.ChannelOutputHeaderConfiguration
    The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The tags associated with the channel.
    ChannelGroupName string
    The name of the channel group associated with the channel configuration.
    ChannelName string
    The name of the channel.
    Description string
    InputSwitchConfiguration ChannelInputSwitchConfigurationArgs
    The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive.
    InputType ChannelInputType

    The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

    The allowed values are:

    • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
    • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
    OutputHeaderConfiguration ChannelOutputHeaderConfigurationArgs
    The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.
    Tags TagArgs
    The tags associated with the channel.
    channelGroupName String
    The name of the channel group associated with the channel configuration.
    channelName String
    The name of the channel.
    description String
    inputSwitchConfiguration ChannelInputSwitchConfiguration
    The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive.
    inputType ChannelInputType

    The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

    The allowed values are:

    • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
    • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
    outputHeaderConfiguration ChannelOutputHeaderConfiguration
    The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.
    tags List<Tag>
    The tags associated with the channel.
    channelGroupName string
    The name of the channel group associated with the channel configuration.
    channelName string
    The name of the channel.
    description string
    inputSwitchConfiguration ChannelInputSwitchConfiguration
    The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive.
    inputType ChannelInputType

    The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

    The allowed values are:

    • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
    • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
    outputHeaderConfiguration ChannelOutputHeaderConfiguration
    The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.
    tags Tag[]
    The tags associated with the channel.
    channel_group_name str
    The name of the channel group associated with the channel configuration.
    channel_name str
    The name of the channel.
    description str
    input_switch_configuration ChannelInputSwitchConfigurationArgs
    The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive.
    input_type ChannelInputType

    The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

    The allowed values are:

    • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
    • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
    output_header_configuration ChannelOutputHeaderConfigurationArgs
    The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.
    tags Sequence[TagArgs]
    The tags associated with the channel.
    channelGroupName String
    The name of the channel group associated with the channel configuration.
    channelName String
    The name of the channel.
    description String
    inputSwitchConfiguration Property Map
    The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive.
    inputType "HLS" | "CMAF"

    The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior.

    The allowed values are:

    • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).
    • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).
    outputHeaderConfiguration Property Map
    The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN.
    tags List<Property Map>
    The tags associated with the channel.

    Outputs

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

    Arn string
    CreatedAt string
    Id string
    The provider-assigned unique ID for this managed resource.
    IngestEndpointUrls List<string>
    IngestEndpoints List<Pulumi.AwsNative.MediaPackageV2.Outputs.ChannelIngestEndpoint>
    ModifiedAt string
    Arn string
    CreatedAt string
    Id string
    The provider-assigned unique ID for this managed resource.
    IngestEndpointUrls []string
    IngestEndpoints []ChannelIngestEndpoint
    ModifiedAt string
    arn String
    createdAt String
    id String
    The provider-assigned unique ID for this managed resource.
    ingestEndpointUrls List<String>
    ingestEndpoints List<ChannelIngestEndpoint>
    modifiedAt String
    arn string
    createdAt string
    id string
    The provider-assigned unique ID for this managed resource.
    ingestEndpointUrls string[]
    ingestEndpoints ChannelIngestEndpoint[]
    modifiedAt string
    arn str
    created_at str
    id str
    The provider-assigned unique ID for this managed resource.
    ingest_endpoint_urls Sequence[str]
    ingest_endpoints Sequence[ChannelIngestEndpoint]
    modified_at str
    arn String
    createdAt String
    id String
    The provider-assigned unique ID for this managed resource.
    ingestEndpointUrls List<String>
    ingestEndpoints List<Property Map>
    modifiedAt String

    Supporting Types

    ChannelIngestEndpoint, ChannelIngestEndpointArgs

    Id string
    Url string
    Id string
    Url string
    id String
    url String
    id string
    url string
    id str
    url str
    id String
    url String

    ChannelInputSwitchConfiguration, ChannelInputSwitchConfigurationArgs

    ChannelInputType, ChannelInputTypeArgs

    Hls
    HLS
    Cmaf
    CMAF
    ChannelInputTypeHls
    HLS
    ChannelInputTypeCmaf
    CMAF
    Hls
    HLS
    Cmaf
    CMAF
    Hls
    HLS
    Cmaf
    CMAF
    HLS
    HLS
    CMAF
    CMAF
    "HLS"
    HLS
    "CMAF"
    CMAF

    ChannelOutputHeaderConfiguration, ChannelOutputHeaderConfigurationArgs

    publishMqcs Boolean
    publishMqcs boolean
    publishMqcs Boolean

    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

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native