aws-cdk.aws-ivs-alpha 2.135.0a0__py3-none-any.whl → 2.230.0a0__py3-none-any.whl

aws_cdk/aws_ivs_alpha/_jsii/__init__.py

@@ -11,16 +11,31 @@ import jsii
 import publication
 import typing_extensions
 
-from typeguard import check_type
+import typeguard
+from importlib.metadata import version as _metadata_package_version
+TYPEGUARD_MAJOR_VERSION = int(_metadata_package_version('typeguard').split('.')[0])
+
+def check_type(argname: str, value: object, expected_type: typing.Any) -> typing.Any:
+    if TYPEGUARD_MAJOR_VERSION <= 2:
+        return typeguard.check_type(argname=argname, value=value, expected_type=expected_type) # type:ignore
+    else:
+        if isinstance(value, jsii._reference_map.InterfaceDynamicProxy): # pyright: ignore [reportAttributeAccessIssue]
+           pass
+        else:
+            if TYPEGUARD_MAJOR_VERSION == 3:
+                typeguard.config.collection_check_strategy = typeguard.CollectionCheckStrategy.ALL_ITEMS # type:ignore
+                typeguard.check_type(value=value, expected_type=expected_type) # type:ignore
+            else:
+                typeguard.check_type(value=value, expected_type=expected_type, collection_check_strategy=typeguard.CollectionCheckStrategy.ALL_ITEMS) # type:ignore
 
 import aws_cdk._jsii
 import constructs._jsii
 
 __jsii_assembly__ = jsii.JSIIAssembly.load(
     "@aws-cdk/aws-ivs-alpha",
-    "2.135.0-alpha.0",
+    "2.230.0-alpha.0",
     __name__[0:-6],
-    "aws-ivs-alpha@2.135.0-alpha.0.jsii.tgz",
+    "aws-ivs-alpha@2.230.0-alpha.0.jsii.tgz",
 )
 
 __all__ = [

{aws_cdk.aws_ivs_alpha-2.135.0a0.dist-info → aws_cdk_aws_ivs_alpha-2.230.0a0.dist-info}/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2018-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+   Copyright 2018-2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

aws_cdk_aws_ivs_alpha-2.230.0a0.dist-info/METADATA

@@ -0,0 +1,257 @@
+Metadata-Version: 2.1
+Name: aws-cdk.aws-ivs-alpha
+Version: 2.230.0a0
+Summary: The CDK Construct Library for AWS::IVS
+Home-page: https://github.com/aws/aws-cdk
+Author: Amazon Web Services
+License: Apache-2.0
+Project-URL: Source, https://github.com/aws/aws-cdk.git
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: JavaScript
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Typing :: Typed
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved
+Classifier: Framework :: AWS CDK
+Classifier: Framework :: AWS CDK :: 2
+Requires-Python: ~=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: aws-cdk-lib <3.0.0,>=2.230.0
+Requires-Dist: constructs <11.0.0,>=10.0.0
+Requires-Dist: jsii <2.0.0,>=1.119.0
+Requires-Dist: publication >=0.0.3
+Requires-Dist: typeguard <4.3.0,>=2.13.3
+
+# AWS::IVS Construct Library
+
+<!--BEGIN STABILITY BANNER-->---
+
+
+![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)
+
+> 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
+)
+```
+
+### 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](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multitrack-video.html).
+
+```python
+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
+    )
+)
+```
+
+### 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
+)
+```

aws_cdk_aws_ivs_alpha-2.230.0a0.dist-info/NOTICE

@@ -0,0 +1,2 @@
+AWS Cloud Development Kit (AWS CDK)
+Copyright 2018-2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.

aws_cdk_aws_ivs_alpha-2.230.0a0.dist-info/RECORD

@@ -0,0 +1,10 @@
+aws_cdk/aws_ivs_alpha/__init__.py,sha256=0gmvGqLSMqzmlkk3pOOJrm-O8cXQDi7vWaZHweWJGGI,84942
+aws_cdk/aws_ivs_alpha/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+aws_cdk/aws_ivs_alpha/_jsii/__init__.py,sha256=ZQu1xtN0G_ur68v18aI_Slde49qgAJzudtNsTzfu70M,1479
+aws_cdk/aws_ivs_alpha/_jsii/aws-ivs-alpha@2.230.0-alpha.0.jsii.tgz,sha256=IX4lZHOMX9j2Z0aNPK6MH9HrCnSGxsN1i4bD24UEfFA,73553
+aws_cdk_aws_ivs_alpha-2.230.0a0.dist-info/LICENSE,sha256=y47tc38H0C4DpGljYUZDl8XxidQjNxxGLq-K4jwv6Xc,11391
+aws_cdk_aws_ivs_alpha-2.230.0a0.dist-info/METADATA,sha256=ZoF9dsaiVcAkWAI73MbyZZ046RBXsGr6ERuo-WZbpvo,9672
+aws_cdk_aws_ivs_alpha-2.230.0a0.dist-info/NOTICE,sha256=ZDV6_xBfMvhFtjjBh_f6lJjhZ2AEWWAGGkx2kLKHiuc,113
+aws_cdk_aws_ivs_alpha-2.230.0a0.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
+aws_cdk_aws_ivs_alpha-2.230.0a0.dist-info/top_level.txt,sha256=1TALAKbuUGsMSrfKWEf268lySCmcqSEO6cDYe_XlLHM,8
+aws_cdk_aws_ivs_alpha-2.230.0a0.dist-info/RECORD,,

{aws_cdk.aws_ivs_alpha-2.135.0a0.dist-info → aws_cdk_aws_ivs_alpha-2.230.0a0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.41.3)
+Generator: setuptools (75.3.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

aws_cdk.aws_ivs_alpha-2.135.0a0.dist-info/METADATA

@@ -1,119 +0,0 @@
-Metadata-Version: 2.1
-Name: aws-cdk.aws-ivs-alpha
-Version: 2.135.0a0
-Summary: The CDK Construct Library for AWS::IVS
-Home-page: https://github.com/aws/aws-cdk
-Author: Amazon Web Services
-License: Apache-2.0
-Project-URL: Source, https://github.com/aws/aws-cdk.git
-Classifier: Intended Audience :: Developers
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: JavaScript
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Typing :: Typed
-Classifier: Development Status :: 4 - Beta
-Classifier: License :: OSI Approved
-Classifier: Framework :: AWS CDK
-Classifier: Framework :: AWS CDK :: 2
-Requires-Python: ~=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-License-File: NOTICE
-Requires-Dist: aws-cdk-lib <3.0.0,>=2.135.0
-Requires-Dist: constructs <11.0.0,>=10.0.0
-Requires-Dist: jsii <2.0.0,>=1.96.0
-Requires-Dist: publication >=0.0.3
-Requires-Dist: typeguard ~=2.13.3
-
-# AWS::IVS Construct Library
-
-<!--BEGIN STABILITY BANNER-->---
-
-
-![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)
-
-> 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")
-```
-
-### 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
-)
-```

aws_cdk.aws_ivs_alpha-2.135.0a0.dist-info/NOTICE

@@ -1,2 +0,0 @@
-AWS Cloud Development Kit (AWS CDK)
-Copyright 2018-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.

aws_cdk.aws_ivs_alpha-2.135.0a0.dist-info/RECORD

@@ -1,10 +0,0 @@
-aws_cdk/aws_ivs_alpha/__init__.py,sha256=Gxr-VC7XuqJW-0BGOXLmhQwbN8Gn2qpcunKOvvHFtWU,31553
-aws_cdk/aws_ivs_alpha/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-aws_cdk/aws_ivs_alpha/_jsii/__init__.py,sha256=YlBKxFgPkUiWyvdHdq9UldU4flBTGnftU_Y0rWtQ9Bw,511
-aws_cdk/aws_ivs_alpha/_jsii/aws-ivs-alpha@2.135.0-alpha.0.jsii.tgz,sha256=xtXHGkqE8ft2nWRI1vHNRXtYVEgsvJZrMg8AxfdudtY,33416
-aws_cdk.aws_ivs_alpha-2.135.0a0.dist-info/LICENSE,sha256=kEDF86xJUQh1E9M7UPKKbHepBEdFxIUyoGfTwQB7zKg,11391
-aws_cdk.aws_ivs_alpha-2.135.0a0.dist-info/METADATA,sha256=B1ihEnjJcBB5EDosU61AQs2Pb-h0qZMY1kglBJy6kWk,4351
-aws_cdk.aws_ivs_alpha-2.135.0a0.dist-info/NOTICE,sha256=dXf56qvx2VDNCaqiRscOD2IH5GbmqbnKRzroZCeLtaQ,113
-aws_cdk.aws_ivs_alpha-2.135.0a0.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
-aws_cdk.aws_ivs_alpha-2.135.0a0.dist-info/top_level.txt,sha256=1TALAKbuUGsMSrfKWEf268lySCmcqSEO6cDYe_XlLHM,8
-aws_cdk.aws_ivs_alpha-2.135.0a0.dist-info/RECORD,,