# AWS::IVS Construct Library
<!--BEGIN STABILITY BANNER-->---
> 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](https://semver.org/) 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.
---
<!--END STABILITY BANNER-->
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](https://github.com/aws/aws-cdk) 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
```python
my_channel = ivs.Channel(self, "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](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/streaming-config.html).
```python
my_channel = ivs.Channel(self, "myChannel",
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](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/streaming-config.html#streaming-config-settings).
```python
my_rtmp_channel = ivs.Channel(self, "myRtmpChannel",
type=ivs.ChannelType.STANDARD,
insecure_ingest=True
)
```
### Importing an existing channel
You can reference an existing channel, for example, if you need to create a
stream key for an existing channel
```python
my_channel = ivs.Channel.from_channel_arn(self, "Channel", my_channel_arn)
```
## 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
```python
my_stream_key = my_channel.add_stream_key("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.
```python
key_pair = ivs.PlaybackKeyPair(self, "PlaybackKeyPair",
public_key_material=my_public_key_pem_string
)
```
Then, when creating a channel, specify the authorized property
```python
my_channel = ivs.Channel(self, "Channel",
authorized=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](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html).
You can create a recording configuration:
```python
# 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
)
```
### 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](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html#r2s3-recording-renditions).
```python
# 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])
)
```
### 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](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html#r2s3-thumbnails).
```python
# 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))
)
```
### 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](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html#r2s3-merge-fragmented-streams).
```python
# recording_bucket: s3.Bucket
recording_configuration = ivs.RecordingConfiguration(self, "RecordingConfiguration",
bucket=recording_bucket,
# set recording reconnect window
recording_reconnect_window=Duration.seconds(60)
)
```
### Attaching Recording Configuration to a Channel
To enable recording for a channel, specify the recording configuration when creating the channel:
```python
# recording_configuration: ivs.RecordingConfiguration
channel = ivs.Channel(self, "Channel",
# set recording configuration
recording_configuration=recording_configuration
)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/aws/aws-cdk",
"name": "aws-cdk.aws-ivs-alpha",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Amazon Web Services",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/7e/93/4408bebc6ff264cdd1a7dbb03f092b857a0b1741b78a3dc47f0a4ab72505/aws_cdk_aws_ivs_alpha-2.170.0a0.tar.gz",
"platform": null,
"description": "# AWS::IVS Construct Library\n\n<!--BEGIN STABILITY BANNER-->---\n\n\n\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\n---\n<!--END STABILITY BANNER-->\n\nAmazon Interactive Video Service (Amazon IVS) is a managed live streaming\nsolution that is quick and easy to set up, and ideal for creating interactive\nvideo experiences. Send your live streams to Amazon IVS using streaming software\nand the service does everything you need to make low-latency live video\navailable to any viewer around the world, letting you focus on building\ninteractive experiences alongside the live video. You can easily customize and\nenhance the audience experience through the Amazon IVS player SDK and timed\nmetadata APIs, allowing you to build a more valuable relationship with your\nviewers on your own websites and applications.\n\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n\n## Channels\n\nAn Amazon IVS channel stores configuration information related to your live\nstream. You first create a channel and then contribute video to it using the\nchannel\u2019s stream key to start your live stream.\n\nYou can create a channel\n\n```python\nmy_channel = ivs.Channel(self, \"Channel\")\n```\n\nYou can use Advanced Channel type by setting the `type` property to\n`ivs.ChannelType.ADVANCED_HD` or `ivs.ChannelType.ADVANCED_SD`.\n\nAdditionally, when using the Advanced Channel type, you can set\nthe `preset` property to `ivs.Preset.CONSTRAINED_BANDWIDTH_DELIVERY`\nor `ivs.Preset.HIGHER_BANDWIDTH_DELIVERY`.\n\nFor more information, see [Amazon IVS Streaming Configuration](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/streaming-config.html).\n\n```python\nmy_channel = ivs.Channel(self, \"myChannel\",\n type=ivs.ChannelType.ADVANCED_HD,\n preset=ivs.Preset.CONSTRAINED_BANDWIDTH_DELIVERY\n)\n```\n\nIf you want to use RTMP ingest, set `insecureIngest` property to `true`.\nBy default, `insecureIngest` is `false` which means using RTMPS ingest.\n\n**\u26a0 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](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/streaming-config.html#streaming-config-settings).\n\n```python\nmy_rtmp_channel = ivs.Channel(self, \"myRtmpChannel\",\n type=ivs.ChannelType.STANDARD,\n insecure_ingest=True\n)\n```\n\n### Importing an existing channel\n\nYou can reference an existing channel, for example, if you need to create a\nstream key for an existing channel\n\n```python\nmy_channel = ivs.Channel.from_channel_arn(self, \"Channel\", my_channel_arn)\n```\n\n## Stream Keys\n\nA Stream Key is used by a broadcast encoder to initiate a stream and identify\nto Amazon IVS which customer and channel the stream is for. If you are\nstoring this value, it should be treated as if it were a password.\n\nYou can create a stream key for a given channel\n\n```python\nmy_stream_key = my_channel.add_stream_key(\"StreamKey\")\n```\n\n## Private Channels\n\nAmazon IVS offers the ability to create private channels, allowing\nyou to restrict your streams by channel or viewer. You control access\nto video playback by enabling playback authorization on channels and\ngenerating signed JSON Web Tokens (JWTs) for authorized playback requests.\n\nA playback token is a JWT that you sign (with a playback authorization key)\nand include with every playback request for a channel that has playback\nauthorization enabled.\n\nIn order for Amazon IVS to validate the token, you need to upload\nthe public key that corresponds to the private key you use to sign the token.\n\n```python\nkey_pair = ivs.PlaybackKeyPair(self, \"PlaybackKeyPair\",\n public_key_material=my_public_key_pem_string\n)\n```\n\nThen, when creating a channel, specify the authorized property\n\n```python\nmy_channel = ivs.Channel(self, \"Channel\",\n authorized=True\n)\n```\n\n## Recording Configurations\n\nAn Amazon IVS Recording Configuration stores settings that specify how a channel's live streams should be recorded.\nYou can configure video quality, thumbnail generation, and where recordings are stored in Amazon S3.\n\nFor more information about IVS recording, see [IVS Auto-Record to Amazon S3 | Low-Latency Streaming](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html).\n\nYou can create a recording configuration:\n\n```python\n# create an S3 bucket for storing recordings\nrecording_bucket = s3.Bucket(self, \"RecordingBucket\")\n\n# create a basic recording configuration\nrecording_configuration = ivs.RecordingConfiguration(self, \"RecordingConfiguration\",\n bucket=recording_bucket\n)\n```\n\n### Renditions of a Recording\n\nWhen you stream content to an Amazon IVS channel, auto-record-to-s3 uses the source video to generate multiple renditions.\n\nFor more information, see [Discovering the Renditions of a Recording](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html#r2s3-recording-renditions).\n\n```python\n# recording_bucket: s3.Bucket\n\n\nrecording_configuration = ivs.RecordingConfiguration(self, \"RecordingConfiguration\",\n bucket=recording_bucket,\n\n # set rendition configuration\n rendition_configuration=ivs.RenditionConfiguration.custom([ivs.Resolution.HD, ivs.Resolution.SD])\n)\n```\n\n### Thumbnail Generation\n\nYou 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.\n\nThumbnail intervals may range from 1 second to 60 seconds; by default, thumbnail recording is enabled, at an interval of 60 seconds.\n\nFor more information, see [Thumbnails](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html#r2s3-thumbnails).\n\n```python\n# recording_bucket: s3.Bucket\n\n\nrecording_configuration = ivs.RecordingConfiguration(self, \"RecordingConfiguration\",\n bucket=recording_bucket,\n\n # set thumbnail settings\n thumbnail_configuration=ivs.ThumbnailConfiguration.interval(ivs.Resolution.HD, [ivs.Storage.LATEST, ivs.Storage.SEQUENTIAL], Duration.seconds(30))\n)\n```\n\n### Merge Fragmented Streams\n\nThe `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.\n\nIn other words, if a broadcast disconnects and then reconnects within the specified interval, the multiple streams are considered a single broadcast and merged together.\n\nFor more information, see [Merge Fragmented Streams](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html#r2s3-merge-fragmented-streams).\n\n```python\n# recording_bucket: s3.Bucket\n\n\nrecording_configuration = ivs.RecordingConfiguration(self, \"RecordingConfiguration\",\n bucket=recording_bucket,\n\n # set recording reconnect window\n recording_reconnect_window=Duration.seconds(60)\n)\n```\n\n### Attaching Recording Configuration to a Channel\n\nTo enable recording for a channel, specify the recording configuration when creating the channel:\n\n```python\n# recording_configuration: ivs.RecordingConfiguration\n\n\nchannel = ivs.Channel(self, \"Channel\",\n # set recording configuration\n recording_configuration=recording_configuration\n)\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "The CDK Construct Library for AWS::IVS",
"version": "2.170.0a0",
"project_urls": {
"Homepage": "https://github.com/aws/aws-cdk",
"Source": "https://github.com/aws/aws-cdk.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8b37634c897695cc036c86e4df27298ce5a07007ce9881a301fddfb8f0f20001",
"md5": "ec62e9bb7b6afbbeb3c1d930bbc968f0",
"sha256": "a97ffd543fb47320a8c37351c1a0e9aace961db80cb708b4612b6434408883af"
},
"downloads": -1,
"filename": "aws_cdk.aws_ivs_alpha-2.170.0a0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ec62e9bb7b6afbbeb3c1d930bbc968f0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 78346,
"upload_time": "2024-11-22T04:41:39",
"upload_time_iso_8601": "2024-11-22T04:41:39.832262Z",
"url": "https://files.pythonhosted.org/packages/8b/37/634c897695cc036c86e4df27298ce5a07007ce9881a301fddfb8f0f20001/aws_cdk.aws_ivs_alpha-2.170.0a0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7e934408bebc6ff264cdd1a7dbb03f092b857a0b1741b78a3dc47f0a4ab72505",
"md5": "dddc522ac5ec9c5694e4e45a517b54b7",
"sha256": "8942dfeac8d6acd4eb8b9a996d3bf9b42020036ba2655858e2f24ba2e475edbb"
},
"downloads": -1,
"filename": "aws_cdk_aws_ivs_alpha-2.170.0a0.tar.gz",
"has_sig": false,
"md5_digest": "dddc522ac5ec9c5694e4e45a517b54b7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 79854,
"upload_time": "2024-11-22T04:42:25",
"upload_time_iso_8601": "2024-11-22T04:42:25.705072Z",
"url": "https://files.pythonhosted.org/packages/7e/93/4408bebc6ff264cdd1a7dbb03f092b857a0b1741b78a3dc47f0a4ab72505/aws_cdk_aws_ivs_alpha-2.170.0a0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-22 04:42:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aws",
"github_project": "aws-cdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aws-cdk.aws-ivs-alpha"
}
JSON
