AWS Native v0.64.0, Jun 2 23
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.
- bool
Whether the channel is authorized.
- Ingest
Endpoint string 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 Pulumi.Aws Native. IVS. Channel Latency Mode Channel latency mode.
- Name string
Channel
- Playback
Url string Channel Playback URL.
- Recording
Configuration stringArn Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
- List<Pulumi.
Aws Native. IVS. Outputs. Channel Tag> A list of key-value pairs that contain metadata for the asset model.
- Type
Pulumi.
Aws Native. IVS. Channel Type 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.
- bool
Whether the channel is authorized.
- Ingest
Endpoint string 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 ChannelLatency Mode Channel latency mode.
- Name string
Channel
- Playback
Url string Channel Playback URL.
- Recording
Configuration stringArn Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
- []Channel
Tag A list of key-value pairs that contain metadata for the asset model.
- Type
Channel
Type 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.
- Boolean
Whether the channel is authorized.
- ingest
Endpoint String Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
- insecure
Ingest Boolean Whether the channel allows insecure ingest.
- latency
Mode ChannelLatency Mode Channel latency mode.
- name String
Channel
- playback
Url String Channel Playback URL.
- recording
Configuration StringArn Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
- List<Channel
Tag> A list of key-value pairs that contain metadata for the asset model.
- type
Channel
Type 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.
- boolean
Whether the channel is authorized.
- ingest
Endpoint string Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
- insecure
Ingest boolean Whether the channel allows insecure ingest.
- latency
Mode ChannelLatency Mode Channel latency mode.
- name string
Channel
- playback
Url string Channel Playback URL.
- recording
Configuration stringArn Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
- Channel
Tag[] A list of key-value pairs that contain metadata for the asset model.
- type
Channel
Type 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.
- 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 ChannelLatency Mode Channel latency mode.
- name str
Channel
- playback_
url str Channel Playback URL.
- recording_
configuration_ strarn Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
- Sequence[Channel
Tag] A list of key-value pairs that contain metadata for the asset model.
- type
Channel
Type 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.
- Boolean
Whether the channel is authorized.
- ingest
Endpoint String Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
- insecure
Ingest Boolean Whether the channel allows insecure ingest.
- latency
Mode "NORMAL" | "LOW" Channel latency mode.
- name String
Channel
- playback
Url String Channel Playback URL.
- recording
Configuration StringArn Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
- 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
ChannelType
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0