AWS Native v0.64.0, Jun 2 23

aws-native.ivs.getChannel

Explore with Pulumi AI

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)
// Output-based functions aren't available in Java yet

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.
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.
Name string: Channel
PlaybackUrl string: Channel Playback URL.
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.IVS.Outputs.ChannelTag>: 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.
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.
Name string: Channel
PlaybackUrl string: Channel Playback URL.
RecordingConfigurationArn string: Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
Tags []ChannelTag: 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.
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.
name String: Channel
playbackUrl String: Channel Playback URL.
recordingConfigurationArn String: Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
tags List<ChannelTag>: 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.
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.
name string: Channel
playbackUrl string: Channel Playback URL.
recordingConfigurationArn string: Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
tags ChannelTag[]: 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.
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.
name str: Channel
playback_url str: Channel Playback URL.
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[ChannelTag]: 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.
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.
name String: Channel
playbackUrl String: Channel Playback URL.
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": 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

ChannelLatencyMode

ChannelTag

Key string
Value string

Key string
Value string

key String
value String

key string
value string

key str
value str

key String
value String

ChannelType

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0