1.204.0

@aws-cdk/aws-ivs module

LanguagePackage
.NETAmazon.CDK.AWS.IVS
Javasoftware.amazon.awscdk.services.ivs
Pythonaws_cdk.aws_ivs
TypeScript@aws-cdk/aws-ivs

AWS::IVS Construct Library

End-of-Support

AWS CDK v1 has reached End-of-Support on 2023-06-01. This package is no longer being updated, and users should migrate to AWS CDK v2.

For more information on how to migrate, see the Migrating to AWS CDK v2 guide.

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');

Example not in your language?

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

Example not in your language?

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');

Example not in your language?

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,
});

Example not in your language?

Then, when creating a channel, specify the authorized property

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

Example not in your language?

← PreviousNext →