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

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

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

aws-native.mediapackage.Channel

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

    Resource schema for AWS::MediaPackage::Channel

    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,
                aws_id: Optional[str] = None,
                description: Optional[str] = None,
                egress_access_logs: Optional[ChannelLogConfigurationArgs] = None,
                hls_ingest: Optional[ChannelHlsIngestArgs] = None,
                ingress_access_logs: Optional[ChannelLogConfigurationArgs] = None,
                tags: Optional[Sequence[_root_inputs.CreateOnlyTagArgs]] = 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: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.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const examplechannelResourceResourceFromMediapackage = new aws_native.mediapackage.Channel("examplechannelResourceResourceFromMediapackage", {
        awsId: "string",
        description: "string",
        egressAccessLogs: {
            logGroupName: "string",
        },
        hlsIngest: {
            ingestEndpoints: [{
                id: "string",
                password: "string",
                url: "string",
                username: "string",
            }],
        },
        ingressAccessLogs: {
            logGroupName: "string",
        },
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    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:

    AwsId string
    The ID of the Channel.
    Description string
    A short text description of the Channel.
    EgressAccessLogs Pulumi.AwsNative.MediaPackage.Inputs.ChannelLogConfiguration
    The configuration parameters for egress access logging.
    HlsIngest Pulumi.AwsNative.MediaPackage.Inputs.ChannelHlsIngest
    An HTTP Live Streaming (HLS) ingest resource configuration.
    IngressAccessLogs Pulumi.AwsNative.MediaPackage.Inputs.ChannelLogConfiguration
    The configuration parameters for egress access logging.
    Tags List<Pulumi.AwsNative.Inputs.CreateOnlyTag>
    A collection of tags associated with a resource
    AwsId string
    The ID of the Channel.
    Description string
    A short text description of the Channel.
    EgressAccessLogs ChannelLogConfigurationArgs
    The configuration parameters for egress access logging.
    HlsIngest ChannelHlsIngestArgs
    An HTTP Live Streaming (HLS) ingest resource configuration.
    IngressAccessLogs ChannelLogConfigurationArgs
    The configuration parameters for egress access logging.
    Tags CreateOnlyTagArgs
    A collection of tags associated with a resource
    awsId String
    The ID of the Channel.
    description String
    A short text description of the Channel.
    egressAccessLogs ChannelLogConfiguration
    The configuration parameters for egress access logging.
    hlsIngest ChannelHlsIngest
    An HTTP Live Streaming (HLS) ingest resource configuration.
    ingressAccessLogs ChannelLogConfiguration
    The configuration parameters for egress access logging.
    tags List<CreateOnlyTag>
    A collection of tags associated with a resource
    awsId string
    The ID of the Channel.
    description string
    A short text description of the Channel.
    egressAccessLogs ChannelLogConfiguration
    The configuration parameters for egress access logging.
    hlsIngest ChannelHlsIngest
    An HTTP Live Streaming (HLS) ingest resource configuration.
    ingressAccessLogs ChannelLogConfiguration
    The configuration parameters for egress access logging.
    tags CreateOnlyTag[]
    A collection of tags associated with a resource
    aws_id str
    The ID of the Channel.
    description str
    A short text description of the Channel.
    egress_access_logs ChannelLogConfigurationArgs
    The configuration parameters for egress access logging.
    hls_ingest ChannelHlsIngestArgs
    An HTTP Live Streaming (HLS) ingest resource configuration.
    ingress_access_logs ChannelLogConfigurationArgs
    The configuration parameters for egress access logging.
    tags Sequence[CreateOnlyTagArgs]
    A collection of tags associated with a resource
    awsId String
    The ID of the Channel.
    description String
    A short text description of the Channel.
    egressAccessLogs Property Map
    The configuration parameters for egress access logging.
    hlsIngest Property Map
    An HTTP Live Streaming (HLS) ingest resource configuration.
    ingressAccessLogs Property Map
    The configuration parameters for egress access logging.
    tags List<Property Map>
    A collection of tags associated with a resource

    Outputs

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

    Arn string
    The Amazon Resource Name (ARN) assigned to the Channel.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The Amazon Resource Name (ARN) assigned to the Channel.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) assigned to the Channel.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) assigned to the Channel.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The Amazon Resource Name (ARN) assigned to the Channel.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) assigned to the Channel.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ChannelHlsIngest, ChannelHlsIngestArgs

    IngestEndpoints List<Pulumi.AwsNative.MediaPackage.Inputs.ChannelIngestEndpoint>
    A list of endpoints to which the source stream should be sent.
    IngestEndpoints []ChannelIngestEndpoint
    A list of endpoints to which the source stream should be sent.
    ingestEndpoints List<ChannelIngestEndpoint>
    A list of endpoints to which the source stream should be sent.
    ingestEndpoints ChannelIngestEndpoint[]
    A list of endpoints to which the source stream should be sent.
    ingest_endpoints Sequence[ChannelIngestEndpoint]
    A list of endpoints to which the source stream should be sent.
    ingestEndpoints List<Property Map>
    A list of endpoints to which the source stream should be sent.

    ChannelIngestEndpoint, ChannelIngestEndpointArgs

    Id string
    The system generated unique identifier for the IngestEndpoint
    Password string
    The system generated password for ingest authentication.
    Url string
    The ingest URL to which the source stream should be sent.
    Username string
    The system generated username for ingest authentication.
    Id string
    The system generated unique identifier for the IngestEndpoint
    Password string
    The system generated password for ingest authentication.
    Url string
    The ingest URL to which the source stream should be sent.
    Username string
    The system generated username for ingest authentication.
    id String
    The system generated unique identifier for the IngestEndpoint
    password String
    The system generated password for ingest authentication.
    url String
    The ingest URL to which the source stream should be sent.
    username String
    The system generated username for ingest authentication.
    id string
    The system generated unique identifier for the IngestEndpoint
    password string
    The system generated password for ingest authentication.
    url string
    The ingest URL to which the source stream should be sent.
    username string
    The system generated username for ingest authentication.
    id str
    The system generated unique identifier for the IngestEndpoint
    password str
    The system generated password for ingest authentication.
    url str
    The ingest URL to which the source stream should be sent.
    username str
    The system generated username for ingest authentication.
    id String
    The system generated unique identifier for the IngestEndpoint
    password String
    The system generated password for ingest authentication.
    url String
    The ingest URL to which the source stream should be sent.
    username String
    The system generated username for ingest authentication.

    ChannelLogConfiguration, ChannelLogConfigurationArgs

    LogGroupName string
    Sets a custom AWS CloudWatch log group name for access logs. If a log group name isn't specified, the defaults are used: /aws/MediaPackage/EgressAccessLogs for egress access logs and /aws/MediaPackage/IngressAccessLogs for ingress access logs.
    LogGroupName string
    Sets a custom AWS CloudWatch log group name for access logs. If a log group name isn't specified, the defaults are used: /aws/MediaPackage/EgressAccessLogs for egress access logs and /aws/MediaPackage/IngressAccessLogs for ingress access logs.
    logGroupName String
    Sets a custom AWS CloudWatch log group name for access logs. If a log group name isn't specified, the defaults are used: /aws/MediaPackage/EgressAccessLogs for egress access logs and /aws/MediaPackage/IngressAccessLogs for ingress access logs.
    logGroupName string
    Sets a custom AWS CloudWatch log group name for access logs. If a log group name isn't specified, the defaults are used: /aws/MediaPackage/EgressAccessLogs for egress access logs and /aws/MediaPackage/IngressAccessLogs for ingress access logs.
    log_group_name str
    Sets a custom AWS CloudWatch log group name for access logs. If a log group name isn't specified, the defaults are used: /aws/MediaPackage/EgressAccessLogs for egress access logs and /aws/MediaPackage/IngressAccessLogs for ingress access logs.
    logGroupName String
    Sets a custom AWS CloudWatch log group name for access logs. If a log group name isn't specified, the defaults are used: /aws/MediaPackage/EgressAccessLogs for egress access logs and /aws/MediaPackage/IngressAccessLogs for ingress access logs.

    CreateOnlyTag, CreateOnlyTagArgs

    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.103.0 published on Monday, Apr 22, 2024 by Pulumi