AWS Native v0.63.0, May 25 23
AWS Native v0.63.0, May 25 23
aws-native.ivs.Channel
Explore with Pulumi AI
Resource Type definition for AWS::IVS::Channel
Example Usage
Example
using System.Collections.Generic;
using Pulumi;
using AwsNative = Pulumi.AwsNative;
return await Deployment.RunAsync(() =>
{
var channel = new AwsNative.IVS.Channel("channel", new()
{
Name = "MyChannel",
Tags = new[]
{
new AwsNative.IVS.Inputs.ChannelTagArgs
{
Key = "MyKey",
Value = "MyValue",
},
},
InsecureIngest = true,
});
var streamKey = new AwsNative.IVS.StreamKey("streamKey", new()
{
ChannelArn = channel.Id,
Tags = new[]
{
new AwsNative.IVS.Inputs.StreamKeyTagArgs
{
Key = "MyKey",
Value = "MyValue",
},
},
});
return new Dictionary<string, object?>
{
["channelArn"] = channel.Id,
["channelIngestEndpoint"] = channel.Ingest_endpoint,
["channelPlaybackUrl"] = channel.Playback_url,
["streamKeyArn"] = streamKey.Id,
};
});
package main
import (
"github.com/pulumi/pulumi-aws-native/sdk/go/aws/ivs"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
channel, err := ivs.NewChannel(ctx, "channel", &ivs.ChannelArgs{
Name: pulumi.String("MyChannel"),
Tags: []ivs.ChannelTagArgs{
{
Key: pulumi.String("MyKey"),
Value: pulumi.String("MyValue"),
},
},
InsecureIngest: pulumi.Bool(true),
})
if err != nil {
return err
}
streamKey, err := ivs.NewStreamKey(ctx, "streamKey", &ivs.StreamKeyArgs{
ChannelArn: channel.ID(),
Tags: []ivs.StreamKeyTagArgs{
{
Key: pulumi.String("MyKey"),
Value: pulumi.String("MyValue"),
},
},
})
if err != nil {
return err
}
ctx.Export("channelArn", channel.ID())
ctx.Export("channelIngestEndpoint", channel.Ingest_endpoint)
ctx.Export("channelPlaybackUrl", channel.Playback_url)
ctx.Export("streamKeyArn", streamKey.ID())
return nil
})
}
Coming soon!
import pulumi
import pulumi_aws_native as aws_native
channel = aws_native.ivs.Channel("channel",
name="MyChannel",
tags=[aws_native.ivs.ChannelTagArgs(
key="MyKey",
value="MyValue",
)],
insecure_ingest=True)
stream_key = aws_native.ivs.StreamKey("streamKey",
channel_arn=channel.id,
tags=[aws_native.ivs.StreamKeyTagArgs(
key="MyKey",
value="MyValue",
)])
pulumi.export("channelArn", channel.id)
pulumi.export("channelIngestEndpoint", channel.ingest_endpoint)
pulumi.export("channelPlaybackUrl", channel.playback_url)
pulumi.export("streamKeyArn", stream_key.id)
import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";
const channel = new aws_native.ivs.Channel("channel", {
name: "MyChannel",
tags: [{
key: "MyKey",
value: "MyValue",
}],
insecureIngest: true,
});
const streamKey = new aws_native.ivs.StreamKey("streamKey", {
channelArn: channel.id,
tags: [{
key: "MyKey",
value: "MyValue",
}],
});
export const channelArn = channel.id;
export const channelIngestEndpoint = channel.ingestEndpoint;
export const channelPlaybackUrl = channel.playbackUrl;
export const streamKeyArn = streamKey.id;
Coming soon!
Example
using System.Collections.Generic;
using Pulumi;
using AwsNative = Pulumi.AwsNative;
return await Deployment.RunAsync(() =>
{
var channel = new AwsNative.IVS.Channel("channel", new()
{
Name = "MyChannel",
Tags = new[]
{
new AwsNative.IVS.Inputs.ChannelTagArgs
{
Key = "MyKey",
Value = "MyValue",
},
},
InsecureIngest = true,
});
var streamKey = new AwsNative.IVS.StreamKey("streamKey", new()
{
ChannelArn = channel.Id,
Tags = new[]
{
new AwsNative.IVS.Inputs.StreamKeyTagArgs
{
Key = "MyKey",
Value = "MyValue",
},
},
});
return new Dictionary<string, object?>
{
["channelArn"] = channel.Id,
["channelIngestEndpoint"] = channel.Ingest_endpoint,
["channelPlaybackUrl"] = channel.Playback_url,
["streamKeyArn"] = streamKey.Id,
};
});
package main
import (
"github.com/pulumi/pulumi-aws-native/sdk/go/aws/ivs"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
channel, err := ivs.NewChannel(ctx, "channel", &ivs.ChannelArgs{
Name: pulumi.String("MyChannel"),
Tags: []ivs.ChannelTagArgs{
{
Key: pulumi.String("MyKey"),
Value: pulumi.String("MyValue"),
},
},
InsecureIngest: pulumi.Bool(true),
})
if err != nil {
return err
}
streamKey, err := ivs.NewStreamKey(ctx, "streamKey", &ivs.StreamKeyArgs{
ChannelArn: channel.ID(),
Tags: []ivs.StreamKeyTagArgs{
{
Key: pulumi.String("MyKey"),
Value: pulumi.String("MyValue"),
},
},
})
if err != nil {
return err
}
ctx.Export("channelArn", channel.ID())
ctx.Export("channelIngestEndpoint", channel.Ingest_endpoint)
ctx.Export("channelPlaybackUrl", channel.Playback_url)
ctx.Export("streamKeyArn", streamKey.ID())
return nil
})
}
Coming soon!
import pulumi
import pulumi_aws_native as aws_native
channel = aws_native.ivs.Channel("channel",
name="MyChannel",
tags=[aws_native.ivs.ChannelTagArgs(
key="MyKey",
value="MyValue",
)],
insecure_ingest=True)
stream_key = aws_native.ivs.StreamKey("streamKey",
channel_arn=channel.id,
tags=[aws_native.ivs.StreamKeyTagArgs(
key="MyKey",
value="MyValue",
)])
pulumi.export("channelArn", channel.id)
pulumi.export("channelIngestEndpoint", channel.ingest_endpoint)
pulumi.export("channelPlaybackUrl", channel.playback_url)
pulumi.export("streamKeyArn", stream_key.id)
import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";
const channel = new aws_native.ivs.Channel("channel", {
name: "MyChannel",
tags: [{
key: "MyKey",
value: "MyValue",
}],
insecureIngest: true,
});
const streamKey = new aws_native.ivs.StreamKey("streamKey", {
channelArn: channel.id,
tags: [{
key: "MyKey",
value: "MyValue",
}],
});
export const channelArn = channel.id;
export const channelIngestEndpoint = channel.ingestEndpoint;
export const channelPlaybackUrl = channel.playbackUrl;
export const streamKeyArn = streamKey.id;
Coming soon!
Create Channel Resource
new Channel(name: string, args?: ChannelArgs, opts?: CustomResourceOptions);
@overload
def Channel(resource_name: str,
opts: Optional[ResourceOptions] = None,
authorized: Optional[bool] = None,
insecure_ingest: Optional[bool] = None,
latency_mode: Optional[ChannelLatencyMode] = None,
name: Optional[str] = None,
recording_configuration_arn: Optional[str] = None,
tags: Optional[Sequence[ChannelTagArgs]] = None,
type: Optional[ChannelType] = None)
@overload
def Channel(resource_name: str,
args: Optional[ChannelArgs] = None,
opts: Optional[ResourceOptions] = None)
func NewChannel(ctx *Context, name string, args *ChannelArgs, opts ...ResourceOption) (*Channel, error)
public Channel(string name, ChannelArgs? args = null, CustomResourceOptions? opts = null)
public Channel(String name, ChannelArgs args)
public Channel(String name, ChannelArgs args, CustomResourceOptions options)
type: aws-native:ivs:Channel
properties: # The arguments to resource properties.
options: # 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.
- 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
The Channel resource accepts the following input properties:
- bool
Whether the channel is authorized.
- Insecure
Ingest bool Whether the channel allows insecure ingest.
- Latency
Mode Pulumi.Aws Native. IVS. Channel Latency Mode Channel latency mode.
- Name string
Channel
- 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. Inputs. Channel Tag Args> 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.
- bool
Whether the channel is authorized.
- Insecure
Ingest bool Whether the channel allows insecure ingest.
- Latency
Mode ChannelLatency Mode Channel latency mode.
- Name string
Channel
- Recording
Configuration stringArn Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
- []Channel
Tag Args 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.
- Boolean
Whether the channel is authorized.
- insecure
Ingest Boolean Whether the channel allows insecure ingest.
- latency
Mode ChannelLatency Mode Channel latency mode.
- name String
Channel
- 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 Args> 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.
- boolean
Whether the channel is authorized.
- insecure
Ingest boolean Whether the channel allows insecure ingest.
- latency
Mode ChannelLatency Mode Channel latency mode.
- name string
Channel
- recording
Configuration stringArn Recording Configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (recording is disabled).
- Channel
Tag Args[] 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.
- bool
Whether the channel is authorized.
- insecure_
ingest bool Whether the channel allows insecure ingest.
- latency_
mode ChannelLatency Mode Channel latency mode.
- name str
Channel
- 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 Args] 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.
- Boolean
Whether the channel is authorized.
- insecure
Ingest Boolean Whether the channel allows insecure ingest.
- latency
Mode "NORMAL" | "LOW" Channel latency mode.
- name String
Channel
- 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the Channel resource produces the following output properties:
- Arn string
Channel ARN is automatically generated on creation and assigned as the unique identifier.
- Id string
The provider-assigned unique ID for this managed resource.
- Ingest
Endpoint string Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
- Playback
Url string Channel Playback URL.
- Arn string
Channel ARN is automatically generated on creation and assigned as the unique identifier.
- Id string
The provider-assigned unique ID for this managed resource.
- Ingest
Endpoint string Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
- Playback
Url string Channel Playback URL.
- arn String
Channel ARN is automatically generated on creation and assigned as the unique identifier.
- id String
The provider-assigned unique ID for this managed resource.
- ingest
Endpoint String Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
- playback
Url String Channel Playback URL.
- arn string
Channel ARN is automatically generated on creation and assigned as the unique identifier.
- id string
The provider-assigned unique ID for this managed resource.
- ingest
Endpoint string Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
- playback
Url string Channel Playback URL.
- arn str
Channel ARN is automatically generated on creation and assigned as the unique identifier.
- id str
The provider-assigned unique ID for this managed resource.
- ingest_
endpoint str Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
- playback_
url str Channel Playback URL.
- arn String
Channel ARN is automatically generated on creation and assigned as the unique identifier.
- id String
The provider-assigned unique ID for this managed resource.
- ingest
Endpoint String Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
- playback
Url String Channel Playback URL.
Supporting Types
ChannelLatencyMode
- Normal
- NORMAL
- Low
- LOW
- Channel
Latency Mode Normal - NORMAL
- Channel
Latency Mode Low - LOW
- Normal
- NORMAL
- Low
- LOW
- Normal
- NORMAL
- Low
- LOW
- NORMAL
- NORMAL
- LOW
- LOW
- "NORMAL"
- NORMAL
- "LOW"
- LOW
ChannelTag
ChannelType
- Standard
- STANDARD
- Basic
- BASIC
- Channel
Type Standard - STANDARD
- Channel
Type Basic - BASIC
- Standard
- STANDARD
- Basic
- BASIC
- Standard
- STANDARD
- Basic
- BASIC
- STANDARD
- STANDARD
- BASIC
- BASIC
- "STANDARD"
- STANDARD
- "BASIC"
- BASIC
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0