Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. ivs
  5. getChannel

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.ivs.getChannel

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

    Resource Type definition for AWS::IVS::Channel

    Using getChannel

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getChannel(args: GetChannelArgs, opts?: InvokeOptions): Promise<GetChannelResult>
function getChannelOutput(args: GetChannelOutputArgs, opts?: InvokeOptions): Output<GetChannelResult>
    def get_channel(arn: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetChannelResult
def get_channel_output(arn: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetChannelResult]
    func LookupChannel(ctx *Context, args *LookupChannelArgs, opts ...InvokeOption) (*LookupChannelResult, error)
func LookupChannelOutput(ctx *Context, args *LookupChannelOutputArgs, opts ...InvokeOption) LookupChannelResultOutput

    > Note: This function is named LookupChannel in the Go SDK.

    public static class GetChannel 
{
    public static Task<GetChannelResult> InvokeAsync(GetChannelArgs args, InvokeOptions? opts = null)
    public static Output<GetChannelResult> Invoke(GetChannelInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetChannelResult> getChannel(GetChannelArgs args, InvokeOptions options)
public static Output<GetChannelResult> getChannel(GetChannelArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:ivs:getChannel
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    Channel ARN is automatically generated on creation and assigned as the unique identifier.
    Arn string
    Channel ARN is automatically generated on creation and assigned as the unique identifier.
    arn String
    Channel ARN is automatically generated on creation and assigned as the unique identifier.
    arn string
    Channel ARN is automatically generated on creation and assigned as the unique identifier.
    arn str
    Channel ARN is automatically generated on creation and assigned as the unique identifier.
    arn String
    Channel ARN is automatically generated on creation and assigned as the unique identifier.

    getChannel Result

    The following output properties are available:

    Arn string
    Channel ARN is automatically generated on creation and assigned as the unique identifier.
    Authorized bool
    Whether the channel is authorized.
    ContainerFormat Pulumi.AwsNative.Ivs.ChannelContainerFormat
    Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.
    IngestEndpoint string
    Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
    InsecureIngest bool
    Whether the channel allows insecure ingest.
    LatencyMode Pulumi.AwsNative.Ivs.ChannelLatencyMode
    Channel latency mode.
    MultitrackInputConfiguration Pulumi.AwsNative.Ivs.Outputs.ChannelMultitrackInputConfiguration
    Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.
    Name string
    Channel
    PlaybackUrl string
    Channel Playback URL.
    Preset Pulumi.AwsNative.Ivs.ChannelPreset
    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
    RecordingConfigurationArn string
    Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    A list of key-value pairs that contain metadata for the asset model.
    Type Pulumi.AwsNative.Ivs.ChannelType
    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.
    Arn string
    Channel ARN is automatically generated on creation and assigned as the unique identifier.
    Authorized bool
    Whether the channel is authorized.
    ContainerFormat ChannelContainerFormat
    Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.
    IngestEndpoint string
    Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
    InsecureIngest bool
    Whether the channel allows insecure ingest.
    LatencyMode ChannelLatencyMode
    Channel latency mode.
    MultitrackInputConfiguration ChannelMultitrackInputConfiguration
    Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.
    Name string
    Channel
    PlaybackUrl string
    Channel Playback URL.
    Preset ChannelPreset
    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
    RecordingConfigurationArn string
    Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
    Tags Tag
    A list of key-value pairs that contain metadata for the asset model.
    Type ChannelType
    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.
    arn String
    Channel ARN is automatically generated on creation and assigned as the unique identifier.
    authorized Boolean
    Whether the channel is authorized.
    containerFormat ChannelContainerFormat
    Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.
    ingestEndpoint String
    Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
    insecureIngest Boolean
    Whether the channel allows insecure ingest.
    latencyMode ChannelLatencyMode
    Channel latency mode.
    multitrackInputConfiguration ChannelMultitrackInputConfiguration
    Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.
    name String
    Channel
    playbackUrl String
    Channel Playback URL.
    preset ChannelPreset
    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
    recordingConfigurationArn String
    Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
    tags List<Tag>
    A list of key-value pairs that contain metadata for the asset model.
    type ChannelType
    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.
    arn string
    Channel ARN is automatically generated on creation and assigned as the unique identifier.
    authorized boolean
    Whether the channel is authorized.
    containerFormat ChannelContainerFormat
    Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.
    ingestEndpoint string
    Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
    insecureIngest boolean
    Whether the channel allows insecure ingest.
    latencyMode ChannelLatencyMode
    Channel latency mode.
    multitrackInputConfiguration ChannelMultitrackInputConfiguration
    Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.
    name string
    Channel
    playbackUrl string
    Channel Playback URL.
    preset ChannelPreset
    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
    recordingConfigurationArn string
    Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
    tags Tag[]
    A list of key-value pairs that contain metadata for the asset model.
    type ChannelType
    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.
    arn str
    Channel ARN is automatically generated on creation and assigned as the unique identifier.
    authorized bool
    Whether the channel is authorized.
    container_format ChannelContainerFormat
    Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.
    ingest_endpoint str
    Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
    insecure_ingest bool
    Whether the channel allows insecure ingest.
    latency_mode ChannelLatencyMode
    Channel latency mode.
    multitrack_input_configuration ChannelMultitrackInputConfiguration
    Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.
    name str
    Channel
    playback_url str
    Channel Playback URL.
    preset ChannelPreset
    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
    recording_configuration_arn str
    Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
    tags Sequence[root_Tag]
    A list of key-value pairs that contain metadata for the asset model.
    type ChannelType
    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.
    arn String
    Channel ARN is automatically generated on creation and assigned as the unique identifier.
    authorized Boolean
    Whether the channel is authorized.
    containerFormat "TS" | "FRAGMENTED_MP4"
    Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.
    ingestEndpoint String
    Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
    insecureIngest Boolean
    Whether the channel allows insecure ingest.
    latencyMode "NORMAL" | "LOW"
    Channel latency mode.
    multitrackInputConfiguration Property Map
    Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.
    name String
    Channel
    playbackUrl String
    Channel Playback URL.
    preset "" | "HIGHER_BANDWIDTH_DELIVERY" | "CONSTRAINED_BANDWIDTH_DELIVERY"
    Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
    recordingConfigurationArn String
    Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
    tags List<Property Map>
    A list of key-value pairs that contain metadata for the asset model.
    type "STANDARD" | "BASIC" | "ADVANCED_SD" | "ADVANCED_HD"
    Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.

    Supporting Types

    ChannelContainerFormat

    ChannelLatencyMode

    ChannelMultitrackInputConfiguration

    Enabled bool
    Indicates whether multitrack input is enabled. Can be set to true only if channel type is STANDARD. Setting enabled to true with any other channel type will cause an exception. If true, then policy, maximumResolution, and containerFormat are required, and containerFormat must be set to FRAGMENTED_MP4. Default: false.
    MaximumResolution Pulumi.AwsNative.Ivs.ChannelMultitrackInputConfigurationMaximumResolution
    Maximum resolution for multitrack input. Required if enabled is true.
    Policy Pulumi.AwsNative.Ivs.ChannelMultitrackInputConfigurationPolicy
    Indicates whether multitrack input is allowed or required. Required if enabled is true.
    Enabled bool
    Indicates whether multitrack input is enabled. Can be set to true only if channel type is STANDARD. Setting enabled to true with any other channel type will cause an exception. If true, then policy, maximumResolution, and containerFormat are required, and containerFormat must be set to FRAGMENTED_MP4. Default: false.
    MaximumResolution ChannelMultitrackInputConfigurationMaximumResolution
    Maximum resolution for multitrack input. Required if enabled is true.
    Policy ChannelMultitrackInputConfigurationPolicy
    Indicates whether multitrack input is allowed or required. Required if enabled is true.
    enabled Boolean
    Indicates whether multitrack input is enabled. Can be set to true only if channel type is STANDARD. Setting enabled to true with any other channel type will cause an exception. If true, then policy, maximumResolution, and containerFormat are required, and containerFormat must be set to FRAGMENTED_MP4. Default: false.
    maximumResolution ChannelMultitrackInputConfigurationMaximumResolution
    Maximum resolution for multitrack input. Required if enabled is true.
    policy ChannelMultitrackInputConfigurationPolicy
    Indicates whether multitrack input is allowed or required. Required if enabled is true.
    enabled boolean
    Indicates whether multitrack input is enabled. Can be set to true only if channel type is STANDARD. Setting enabled to true with any other channel type will cause an exception. If true, then policy, maximumResolution, and containerFormat are required, and containerFormat must be set to FRAGMENTED_MP4. Default: false.
    maximumResolution ChannelMultitrackInputConfigurationMaximumResolution
    Maximum resolution for multitrack input. Required if enabled is true.
    policy ChannelMultitrackInputConfigurationPolicy
    Indicates whether multitrack input is allowed or required. Required if enabled is true.
    enabled bool
    Indicates whether multitrack input is enabled. Can be set to true only if channel type is STANDARD. Setting enabled to true with any other channel type will cause an exception. If true, then policy, maximumResolution, and containerFormat are required, and containerFormat must be set to FRAGMENTED_MP4. Default: false.
    maximum_resolution ChannelMultitrackInputConfigurationMaximumResolution
    Maximum resolution for multitrack input. Required if enabled is true.
    policy ChannelMultitrackInputConfigurationPolicy
    Indicates whether multitrack input is allowed or required. Required if enabled is true.
    enabled Boolean
    Indicates whether multitrack input is enabled. Can be set to true only if channel type is STANDARD. Setting enabled to true with any other channel type will cause an exception. If true, then policy, maximumResolution, and containerFormat are required, and containerFormat must be set to FRAGMENTED_MP4. Default: false.
    maximumResolution "SD" | "HD" | "FULL_HD"
    Maximum resolution for multitrack input. Required if enabled is true.
    policy "ALLOW" | "REQUIRE"
    Indicates whether multitrack input is allowed or required. Required if enabled is true.

    ChannelMultitrackInputConfigurationMaximumResolution

    ChannelMultitrackInputConfigurationPolicy

    ChannelPreset

    ChannelType

    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 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