@aws-cdk/aws-ivs-alpha

AWS::IVS Construct Library

Version 2.274.0-alpha.0

Separate package

@aws-cdk/aws-ivs-alpha is not part of aws-cdk-lib — install it separately:

npm install @aws-cdk/aws-ivs-alpha
pip install aws-cdk.aws-ivs-alpha

This module is experimental (alpha): its API may change in any release, without a major version bump.

---

The APIs of higher level constructs in this module are experimental and under active development. They are subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model and breaking changes will be announced in the release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.

---

Amazon Interactive Video Service (Amazon IVS) is a managed live streaming solution that is quick and easy to set up, and ideal for creating interactive video experiences. Send your live streams to Amazon IVS using streaming software and the service does everything you need to make low-latency live video available to any viewer around the world, letting you focus on building interactive experiences alongside the live video. You can easily customize and enhance the audience experience through the Amazon IVS player SDK and timed metadata APIs, allowing you to build a more valuable relationship with your viewers on your own websites and applications.

This module is part of the AWS Cloud Development Kit project.

Channels

An Amazon IVS channel stores configuration information related to your live stream. You first create a channel and then contribute video to it using the channel’s stream key to start your live stream.

You can create a channel

const myChannel = new ivs.Channel(this, 'Channel');

my_channel = ivs.Channel(self, "Channel")

Channel myChannel = new Channel(this, "Channel");

var myChannel = new Channel(this, "Channel");

myChannel := ivs.NewChannel(this, jsii.String("Channel"))

You can use Advanced Channel type by setting the type property to ivs.ChannelType.ADVANCED_HD or ivs.ChannelType.ADVANCED_SD.

Additionally, when using the Advanced Channel type, you can set the preset property to ivs.Preset.CONSTRAINED_BANDWIDTH_DELIVERY or ivs.Preset.HIGHER_BANDWIDTH_DELIVERY.

For more information, see Amazon IVS Streaming Configuration.

const myChannel = new ivs.Channel(this, 'myChannel', {
  type: ivs.ChannelType.ADVANCED_HD,
  preset: ivs.Preset.CONSTRAINED_BANDWIDTH_DELIVERY,
});

my_channel = ivs.Channel(self, "myChannel",
    type=ivs.ChannelType.ADVANCED_HD,
    preset=ivs.Preset.CONSTRAINED_BANDWIDTH_DELIVERY
)

Channel myChannel = Channel.Builder.create(this, "myChannel")
        .type(ChannelType.ADVANCED_HD)
        .preset(Preset.CONSTRAINED_BANDWIDTH_DELIVERY)
        .build();

var myChannel = new Channel(this, "myChannel", new ChannelProps {
    Type = ChannelType.ADVANCED_HD,
    Preset = Preset.CONSTRAINED_BANDWIDTH_DELIVERY
});

myChannel := ivs.NewChannel(this, jsii.String("myChannel"), &ChannelProps{
	Type: ivs.ChannelType_ADVANCED_HD,
	Preset: ivs.Preset_CONSTRAINED_BANDWIDTH_DELIVERY,
})

If you want to use RTMP ingest, set insecureIngest property to true. By default, insecureIngest is false which means using RTMPS ingest.

⚠ Note: RTMP ingest might result in reduced security for your streams. AWS recommends that you use RTMPS for ingest, unless you have specific and verified use cases. For more information, see Encoder Settings.

const myRtmpChannel = new ivs.Channel(this, 'myRtmpChannel', {
  type: ivs.ChannelType.STANDARD,
  insecureIngest: true, // default value is false
});

my_rtmp_channel = ivs.Channel(self, "myRtmpChannel",
    type=ivs.ChannelType.STANDARD,
    insecure_ingest=True
)

Channel myRtmpChannel = Channel.Builder.create(this, "myRtmpChannel")
        .type(ChannelType.STANDARD)
        .insecureIngest(true)
        .build();

var myRtmpChannel = new Channel(this, "myRtmpChannel", new ChannelProps {
    Type = ChannelType.STANDARD,
    InsecureIngest = true
});

myRtmpChannel := ivs.NewChannel(this, jsii.String("myRtmpChannel"), &ChannelProps{
	Type: ivs.ChannelType_STANDARD,
	InsecureIngest: jsii.Boolean(true),
})

Multitrack Video

Multitrack video is a new, low-latency streaming paradigm supported by Amazon Interactive Video Service (IVS) and services that use Amazon IVS.

You can use Multitrack Video by setting the multitrackInputConfiguration property. Multitrack Video requires both a STANDARD Channel and Fragmented Mp4.

For more information, see Amazon IVS Multitrack Video.

new ivs.Channel(this, 'ChannelWithMultitrackVideo', {
  type: ivs.ChannelType.STANDARD,
  containerFormat: ivs.ContainerFormat.FRAGMENTED_MP4,
  multitrackInputConfiguration: {
    maximumResolution: ivs.MaximumResolution.HD,
    policy: ivs.Policy.ALLOW,
  },
});

ivs.Channel(self, "ChannelWithMultitrackVideo",
    type=ivs.ChannelType.STANDARD,
    container_format=ivs.ContainerFormat.FRAGMENTED_MP4,
    multitrack_input_configuration=ivs.MultitrackInputConfiguration(
        maximum_resolution=ivs.MaximumResolution.HD,
        policy=ivs.Policy.ALLOW
    )
)

Channel.Builder.create(this, "ChannelWithMultitrackVideo")
        .type(ChannelType.STANDARD)
        .containerFormat(ContainerFormat.FRAGMENTED_MP4)
        .multitrackInputConfiguration(MultitrackInputConfiguration.builder()
                .maximumResolution(MaximumResolution.HD)
                .policy(Policy.ALLOW)
                .build())
        .build();

new Channel(this, "ChannelWithMultitrackVideo", new ChannelProps {
    Type = ChannelType.STANDARD,
    ContainerFormat = ContainerFormat.FRAGMENTED_MP4,
    MultitrackInputConfiguration = new MultitrackInputConfiguration {
        MaximumResolution = MaximumResolution.HD,
        Policy = Policy.ALLOW
    }
});

ivs.NewChannel(this, jsii.String("ChannelWithMultitrackVideo"), &ChannelProps{
	Type: ivs.ChannelType_STANDARD,
	ContainerFormat: ivs.ContainerFormat_FRAGMENTED_MP4,
	MultitrackInputConfiguration: &MultitrackInputConfiguration{
		MaximumResolution: ivs.MaximumResolution_HD,
		Policy: ivs.Policy_ALLOW,
	},
})

Importing an existing channel

You can reference an existing channel, for example, if you need to create a stream key for an existing channel

const myChannel = ivs.Channel.fromChannelArn(this, 'Channel', myChannelArn);

my_channel = ivs.Channel.from_channel_arn(self, "Channel", my_channel_arn)

IChannel myChannel = Channel.fromChannelArn(this, "Channel", myChannelArn);

var myChannel = Channel.FromChannelArn(this, "Channel", myChannelArn);

myChannel := ivs.Channel_FromChannelArn(this, jsii.String("Channel"), myChannelArn)

Stream Keys

A Stream Key is used by a broadcast encoder to initiate a stream and identify to Amazon IVS which customer and channel the stream is for. If you are storing this value, it should be treated as if it were a password.

You can create a stream key for a given channel

const myStreamKey = myChannel.addStreamKey('StreamKey');

my_stream_key = my_channel.add_stream_key("StreamKey")

StreamKey myStreamKey = myChannel.addStreamKey("StreamKey");

var myStreamKey = myChannel.AddStreamKey("StreamKey");

myStreamKey := myChannel.AddStreamKey(jsii.String("StreamKey"))

Private Channels

Amazon IVS offers the ability to create private channels, allowing you to restrict your streams by channel or viewer. You control access to video playback by enabling playback authorization on channels and generating signed JSON Web Tokens (JWTs) for authorized playback requests.

A playback token is a JWT that you sign (with a playback authorization key) and include with every playback request for a channel that has playback authorization enabled.

In order for Amazon IVS to validate the token, you need to upload the public key that corresponds to the private key you use to sign the token.

const keyPair = new ivs.PlaybackKeyPair(this, 'PlaybackKeyPair', {
  publicKeyMaterial: myPublicKeyPemString,
});

key_pair = ivs.PlaybackKeyPair(self, "PlaybackKeyPair",
    public_key_material=my_public_key_pem_string
)

PlaybackKeyPair keyPair = PlaybackKeyPair.Builder.create(this, "PlaybackKeyPair")
        .publicKeyMaterial(myPublicKeyPemString)
        .build();

var keyPair = new PlaybackKeyPair(this, "PlaybackKeyPair", new PlaybackKeyPairProps {
    PublicKeyMaterial = myPublicKeyPemString
});

keyPair := ivs.NewPlaybackKeyPair(this, jsii.String("PlaybackKeyPair"), &PlaybackKeyPairProps{
	PublicKeyMaterial: myPublicKeyPemString,
})

Then, when creating a channel, specify the authorized property

const myChannel = new ivs.Channel(this, 'Channel', {
  authorized: true, // default value is false
});

my_channel = ivs.Channel(self, "Channel",
    authorized=True
)

Channel myChannel = Channel.Builder.create(this, "Channel")
        .authorized(true)
        .build();

var myChannel = new Channel(this, "Channel", new ChannelProps {
    Authorized = true
});

myChannel := ivs.NewChannel(this, jsii.String("Channel"), &ChannelProps{
	Authorized: jsii.Boolean(true),
})

Recording Configurations

An Amazon IVS Recording Configuration stores settings that specify how a channel's live streams should be recorded. You can configure video quality, thumbnail generation, and where recordings are stored in Amazon S3.

For more information about IVS recording, see IVS Auto-Record to Amazon S3 | Low-Latency Streaming.

You can create a recording configuration:

// create an S3 bucket for storing recordings
const recordingBucket = new s3.Bucket(this, 'RecordingBucket');

// create a basic recording configuration
const recordingConfiguration = new ivs.RecordingConfiguration(this, 'RecordingConfiguration', {
  bucket: recordingBucket,
});

# create an S3 bucket for storing recordings
recording_bucket = s3.Bucket(self, "RecordingBucket")

# create a basic recording configuration
recording_configuration = ivs.RecordingConfiguration(self, "RecordingConfiguration",
    bucket=recording_bucket
)

// create an S3 bucket for storing recordings
Bucket recordingBucket = new Bucket(this, "RecordingBucket");

// create a basic recording configuration
RecordingConfiguration recordingConfiguration = RecordingConfiguration.Builder.create(this, "RecordingConfiguration")
        .bucket(recordingBucket)
        .build();

// create an S3 bucket for storing recordings
var recordingBucket = new Bucket(this, "RecordingBucket");

// create a basic recording configuration
var recordingConfiguration = new RecordingConfiguration(this, "RecordingConfiguration", new RecordingConfigurationProps {
    Bucket = recordingBucket
});

// create an S3 bucket for storing recordings
recordingBucket := s3.NewBucket(this, jsii.String("RecordingBucket"))

// create a basic recording configuration
recordingConfiguration := ivs.NewRecordingConfiguration(this, jsii.String("RecordingConfiguration"), &RecordingConfigurationProps{
	Bucket: recordingBucket,
})

Renditions of a Recording

When you stream content to an Amazon IVS channel, auto-record-to-s3 uses the source video to generate multiple renditions.

For more information, see Discovering the Renditions of a Recording.

declare const recordingBucket: s3.Bucket;

const recordingConfiguration= new ivs.RecordingConfiguration(this, 'RecordingConfiguration', {
  bucket: recordingBucket,

  // set rendition configuration
  renditionConfiguration: ivs.RenditionConfiguration.custom([ivs.Resolution.HD, ivs.Resolution.SD]),
});

# recording_bucket: s3.Bucket


recording_configuration = ivs.RecordingConfiguration(self, "RecordingConfiguration",
    bucket=recording_bucket,

    # set rendition configuration
    rendition_configuration=ivs.RenditionConfiguration.custom([ivs.Resolution.HD, ivs.Resolution.SD])
)

Bucket recordingBucket;


RecordingConfiguration recordingConfiguration = RecordingConfiguration.Builder.create(this, "RecordingConfiguration")
        .bucket(recordingBucket)

        // set rendition configuration
        .renditionConfiguration(RenditionConfiguration.custom(List.of(Resolution.HD, Resolution.SD)))
        .build();

Bucket recordingBucket;


var recordingConfiguration = new RecordingConfiguration(this, "RecordingConfiguration", new RecordingConfigurationProps {
    Bucket = recordingBucket,

    // set rendition configuration
    RenditionConfiguration = RenditionConfiguration.Custom(new [] { Resolution.HD, Resolution.SD })
});

var recordingBucket Bucket


recordingConfiguration := ivs.NewRecordingConfiguration(this, jsii.String("RecordingConfiguration"), &RecordingConfigurationProps{
	Bucket: recordingBucket,

	// set rendition configuration
	RenditionConfiguration: ivs.RenditionConfiguration_Custom([]Resolution{
		ivs.Resolution_HD,
		ivs.Resolution_SD,
	}),
})

Thumbnail Generation

You can enable or disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

Thumbnail intervals may range from 1 second to 60 seconds; by default, thumbnail recording is enabled, at an interval of 60 seconds.

For more information, see Thumbnails.

declare const recordingBucket: s3.Bucket;

const recordingConfiguration = new ivs.RecordingConfiguration(this, 'RecordingConfiguration', {
  bucket: recordingBucket,

  // set thumbnail settings
  thumbnailConfiguration: ivs.ThumbnailConfiguration.interval(ivs.Resolution.HD, [ivs.Storage.LATEST, ivs.Storage.SEQUENTIAL], Duration.seconds(30)),
});

# recording_bucket: s3.Bucket


recording_configuration = ivs.RecordingConfiguration(self, "RecordingConfiguration",
    bucket=recording_bucket,

    # set thumbnail settings
    thumbnail_configuration=ivs.ThumbnailConfiguration.interval(ivs.Resolution.HD, [ivs.Storage.LATEST, ivs.Storage.SEQUENTIAL], Duration.seconds(30))
)

Bucket recordingBucket;


RecordingConfiguration recordingConfiguration = RecordingConfiguration.Builder.create(this, "RecordingConfiguration")
        .bucket(recordingBucket)

        // set thumbnail settings
        .thumbnailConfiguration(ThumbnailConfiguration.interval(Resolution.HD, List.of(Storage.LATEST, Storage.SEQUENTIAL), Duration.seconds(30)))
        .build();

Bucket recordingBucket;


var recordingConfiguration = new RecordingConfiguration(this, "RecordingConfiguration", new RecordingConfigurationProps {
    Bucket = recordingBucket,

    // set thumbnail settings
    ThumbnailConfiguration = ThumbnailConfiguration.Interval(Resolution.HD, new [] { Storage.LATEST, Storage.SEQUENTIAL }, Duration.Seconds(30))
});

var recordingBucket Bucket


recordingConfiguration := ivs.NewRecordingConfiguration(this, jsii.String("RecordingConfiguration"), &RecordingConfigurationProps{
	Bucket: recordingBucket,

	// set thumbnail settings
	ThumbnailConfiguration: ivs.ThumbnailConfiguration_Interval(ivs.Resolution_HD, []Storage{
		ivs.Storage_LATEST,
		ivs.Storage_SEQUENTIAL,
	}, awscdk.Duration_Seconds(jsii.Number(30))),
})

Merge Fragmented Streams

The recordingReconnectWindow property allows you to specify a window of time (in seconds) during which, if your stream is interrupted and a new stream is started, Amazon IVS tries to record to the same S3 prefix as the previous stream.

In other words, if a broadcast disconnects and then reconnects within the specified interval, the multiple streams are considered a single broadcast and merged together.

For more information, see Merge Fragmented Streams.

declare const recordingBucket: s3.Bucket;

const recordingConfiguration= new ivs.RecordingConfiguration(this, 'RecordingConfiguration', {
  bucket: recordingBucket,

  // set recording reconnect window
  recordingReconnectWindow: Duration.seconds(60),
});

# recording_bucket: s3.Bucket


recording_configuration = ivs.RecordingConfiguration(self, "RecordingConfiguration",
    bucket=recording_bucket,

    # set recording reconnect window
    recording_reconnect_window=Duration.seconds(60)
)

Bucket recordingBucket;


RecordingConfiguration recordingConfiguration = RecordingConfiguration.Builder.create(this, "RecordingConfiguration")
        .bucket(recordingBucket)

        // set recording reconnect window
        .recordingReconnectWindow(Duration.seconds(60))
        .build();

Bucket recordingBucket;


var recordingConfiguration = new RecordingConfiguration(this, "RecordingConfiguration", new RecordingConfigurationProps {
    Bucket = recordingBucket,

    // set recording reconnect window
    RecordingReconnectWindow = Duration.Seconds(60)
});

var recordingBucket Bucket


recordingConfiguration := ivs.NewRecordingConfiguration(this, jsii.String("RecordingConfiguration"), &RecordingConfigurationProps{
	Bucket: recordingBucket,

	// set recording reconnect window
	RecordingReconnectWindow: awscdk.Duration_Seconds(jsii.Number(60)),
})

Attaching Recording Configuration to a Channel

To enable recording for a channel, specify the recording configuration when creating the channel:

declare const recordingConfiguration: ivs.RecordingConfiguration;

const channel = new ivs.Channel(this, 'Channel', {
  // set recording configuration
  recordingConfiguration: recordingConfiguration,
});

# recording_configuration: ivs.RecordingConfiguration


channel = ivs.Channel(self, "Channel",
    # set recording configuration
    recording_configuration=recording_configuration
)

RecordingConfiguration recordingConfiguration;


Channel channel = Channel.Builder.create(this, "Channel")
        // set recording configuration
        .recordingConfiguration(recordingConfiguration)
        .build();

RecordingConfiguration recordingConfiguration;


var channel = new Channel(this, "Channel", new ChannelProps {
    // set recording configuration
    RecordingConfiguration = recordingConfiguration
});

var recordingConfiguration RecordingConfiguration


channel := ivs.NewChannel(this, jsii.String("Channel"), &ChannelProps{
	// set recording configuration
	RecordingConfiguration: recordingConfiguration,
})

Types

Name	Kind	Summary
Channel	Construct (L2)	A new IVS channel.
PlaybackKeyPair	Construct (L2)	A new IVS Playback Key Pair.
RecordingConfiguration	Construct (L2)	The IVS Recording configuration.
StreamKey	Construct (L2)	A new IVS Stream Key.
ChannelProps	Struct	Properties for creating a new Channel.
ChannelType	Enum	The channel type, which determines the allowable resolution and bitrate.
ContainerFormat	Enum	Container Format.
IChannel	Interface	Represents an IVS Channel.
IPlaybackKeyPair	Interface	Represents an IVS Playback Key Pair.
IRecordingConfiguration	Interface	Represents the IVS Recording configuration.
IStreamKey	Interface	Represents an IVS Stream Key.
LatencyMode	Enum	Channel latency mode.
MaximumResolution	Enum	Maximum resolution for multitrack input.
MultitrackInputConfiguration	Struct	A complex type that specifies multitrack input configuration.
PlaybackKeyPairProps	Struct	Properties for creating a new Playback Key Pair.
Policy	Enum	Whether multitrack input is allowed or required.
Preset	Enum	An optional transcode preset for the channel.
RecordingConfigurationProps	Struct	Properties of the IVS Recording configuration.
RecordingMode	Enum	Thumbnail recording mode.
RenditionConfiguration	Class	Rendition configuration for IVS Recording configuration.
RenditionSelection	Enum	Rendition selection mode.
Resolution	Enum	Resolution for rendition.
Storage	Enum	The format in which thumbnails are recorded for a stream.
StreamKeyProps	Struct	Properties for creating a new Stream Key.
ThumbnailConfiguration	Class	Thumbnail configuration for IVS Recording configuration.