aws-cdk.aws-ivs-alpha 2.143.1a0__py3-none-any.whl → 2.144.0a0__py3-none-any.whl

aws_cdk/aws_ivs_alpha/__init__.py

@@ -39,6 +39,22 @@ You can create a channel
 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
+)
+```
+
 ### Importing an existing channel
 
 You can reference an existing channel, for example, if you need to create a
@@ -116,6 +132,7 @@ import constructs as _constructs_77d1e7e8
         "authorized": "authorized",
         "channel_name": "channelName",
         "latency_mode": "latencyMode",
+        "preset": "preset",
         "type": "type",
     },
 )
@@ -126,6 +143,7 @@ class ChannelProps:
         authorized: typing.Optional[builtins.bool] = None,
         channel_name: typing.Optional[builtins.str] = None,
         latency_mode: typing.Optional["LatencyMode"] = None,
+        preset: typing.Optional["Preset"] = None,
         type: typing.Optional["ChannelType"] = None,
     ) -> None:
         '''(experimental) Properties for creating a new Channel.
@@ -133,6 +151,7 @@ class ChannelProps:
         :param authorized: (experimental) Whether the channel is authorized. If you wish to make an authorized channel, you will need to ensure that a PlaybackKeyPair has been uploaded to your account as this is used to validate the signed JWT that is required for authorization Default: false
         :param channel_name: (experimental) A name for the channel. Default: Automatically generated name
         :param latency_mode: (experimental) Channel latency mode. Default: LatencyMode.LOW
+        :param preset: (experimental) An optional transcode preset for the channel. Can be used for ADVANCED_HD and ADVANCED_SD channel types. When LOW or STANDARD is used, the preset will be overridden and set to none regardless of the value provided. Default: - Preset.HIGHER_BANDWIDTH_DELIVERY if channelType is ADVANCED_SD or ADVANCED_HD, none otherwise
         :param type: (experimental) The channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream will disconnect immediately Default: ChannelType.STANDARD
 
         :stability: experimental
@@ -140,8 +159,9 @@ class ChannelProps:
 
         Example::
 
-            my_channel = ivs.Channel(self, "Channel",
-                authorized=True
+            my_channel = ivs.Channel(self, "myChannel",
+                type=ivs.ChannelType.ADVANCED_HD,
+                preset=ivs.Preset.CONSTRAINED_BANDWIDTH_DELIVERY
             )
         '''
         if __debug__:
@@ -149,6 +169,7 @@ class ChannelProps:
             check_type(argname="argument authorized", value=authorized, expected_type=type_hints["authorized"])
             check_type(argname="argument channel_name", value=channel_name, expected_type=type_hints["channel_name"])
             check_type(argname="argument latency_mode", value=latency_mode, expected_type=type_hints["latency_mode"])
+            check_type(argname="argument preset", value=preset, expected_type=type_hints["preset"])
             check_type(argname="argument type", value=type, expected_type=type_hints["type"])
         self._values: typing.Dict[builtins.str, typing.Any] = {}
         if authorized is not None:
@@ -157,6 +178,8 @@ class ChannelProps:
             self._values["channel_name"] = channel_name
         if latency_mode is not None:
             self._values["latency_mode"] = latency_mode
+        if preset is not None:
+            self._values["preset"] = preset
         if type is not None:
             self._values["type"] = type
 
@@ -197,6 +220,20 @@ class ChannelProps:
         result = self._values.get("latency_mode")
         return typing.cast(typing.Optional["LatencyMode"], result)
 
+    @builtins.property
+    def preset(self) -> typing.Optional["Preset"]:
+        '''(experimental) An optional transcode preset for the channel.
+
+        Can be used for ADVANCED_HD and ADVANCED_SD channel types.
+        When LOW or STANDARD is used, the preset will be overridden and set to none regardless of the value provided.
+
+        :default: - Preset.HIGHER_BANDWIDTH_DELIVERY if channelType is ADVANCED_SD or ADVANCED_HD, none otherwise
+
+        :stability: experimental
+        '''
+        result = self._values.get("preset")
+        return typing.cast(typing.Optional["Preset"], result)
+
     @builtins.property
     def type(self) -> typing.Optional["ChannelType"]:
         '''(experimental) The channel type, which determines the allowable resolution and bitrate.
@@ -228,21 +265,47 @@ class ChannelType(enum.Enum):
 
     If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.
 
+    :see: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html
     :stability: experimental
+    :exampleMetadata: infused
+
+    Example::
+
+        my_channel = ivs.Channel(self, "myChannel",
+            type=ivs.ChannelType.ADVANCED_HD,
+            preset=ivs.Preset.CONSTRAINED_BANDWIDTH_DELIVERY
+        )
     '''
 
     STANDARD = "STANDARD"
     '''(experimental) Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions.
 
-    :see: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html
+    Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps.
+    Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
+
     :stability: experimental
     '''
     BASIC = "BASIC"
-    '''(experimental) delivers the original input to viewers.
+    '''(experimental) Delivers the original input to viewers.
 
     The viewer’s video-quality choice is limited to the original input.
 
-    :see: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html
+    :stability: experimental
+    '''
+    ADVANCED_SD = "ADVANCED_SD"
+    '''(experimental) Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions.
+
+    Input resolution can be up to 1080p and bitrate can be up to 8.5 Mbps; output is capped at SD quality (480p).
+    Audio for all renditions is transcoded, and an audio-only rendition is available.
+
+    :stability: experimental
+    '''
+    ADVANCED_HD = "ADVANCED_HD"
+    '''(experimental) Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions.
+
+    Input resolution can be up to 1080p and bitrate can be up to 8.5 Mbps; output is capped at HD quality (720p).
+    Audio for all renditions is transcoded, and an audio-only rendition is available.
+
     :stability: experimental
     '''
 
@@ -570,6 +633,40 @@ class PlaybackKeyPairProps:
         )
 
 
+@jsii.enum(jsii_type="@aws-cdk/aws-ivs-alpha.Preset")
+class Preset(enum.Enum):
+    '''(experimental) An optional transcode preset for the channel.
+
+    This is selectable only for ADVANCED_HD and ADVANCED_SD channel types.
+
+    :see: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html
+    :stability: experimental
+    :exampleMetadata: infused
+
+    Example::
+
+        my_channel = ivs.Channel(self, "myChannel",
+            type=ivs.ChannelType.ADVANCED_HD,
+            preset=ivs.Preset.CONSTRAINED_BANDWIDTH_DELIVERY
+        )
+    '''
+
+    CONSTRAINED_BANDWIDTH_DELIVERY = "CONSTRAINED_BANDWIDTH_DELIVERY"
+    '''(experimental) Use a lower bitrate than STANDARD for each quality level.
+
+    Use it if you have low download bandwidth and/or simple video content (e.g., talking heads).
+
+    :stability: experimental
+    '''
+    HIGHER_BANDWIDTH_DELIVERY = "HIGHER_BANDWIDTH_DELIVERY"
+    '''(experimental) Use a higher bitrate for each quality level.
+
+    Use it if you have high download bandwidth and/or complex video content (e.g., flashes and quick scene changes).
+
+    :stability: experimental
+    '''
+
+
 @jsii.implements(IStreamKey)
 class StreamKey(
     _aws_cdk_ceddda9d.Resource,
@@ -700,7 +797,7 @@ class Channel(
 
     Example::
 
-        my_channel = ivs.Channel(self, "Channel")
+        my_channel = ivs.Channel.from_channel_arn(self, "Channel", my_channel_arn)
     '''
 
     def __init__(
@@ -711,6 +808,7 @@ class Channel(
         authorized: typing.Optional[builtins.bool] = None,
         channel_name: typing.Optional[builtins.str] = None,
         latency_mode: typing.Optional[LatencyMode] = None,
+        preset: typing.Optional[Preset] = None,
         type: typing.Optional[ChannelType] = None,
     ) -> None:
         '''
@@ -719,6 +817,7 @@ class Channel(
         :param authorized: (experimental) Whether the channel is authorized. If you wish to make an authorized channel, you will need to ensure that a PlaybackKeyPair has been uploaded to your account as this is used to validate the signed JWT that is required for authorization Default: false
         :param channel_name: (experimental) A name for the channel. Default: Automatically generated name
         :param latency_mode: (experimental) Channel latency mode. Default: LatencyMode.LOW
+        :param preset: (experimental) An optional transcode preset for the channel. Can be used for ADVANCED_HD and ADVANCED_SD channel types. When LOW or STANDARD is used, the preset will be overridden and set to none regardless of the value provided. Default: - Preset.HIGHER_BANDWIDTH_DELIVERY if channelType is ADVANCED_SD or ADVANCED_HD, none otherwise
         :param type: (experimental) The channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream will disconnect immediately Default: ChannelType.STANDARD
 
         :stability: experimental
@@ -731,6 +830,7 @@ class Channel(
             authorized=authorized,
             channel_name=channel_name,
             latency_mode=latency_mode,
+            preset=preset,
             type=type,
         )
 
@@ -819,6 +919,7 @@ __all__ = [
     "LatencyMode",
     "PlaybackKeyPair",
     "PlaybackKeyPairProps",
+    "Preset",
     "StreamKey",
     "StreamKeyProps",
 ]
@@ -830,6 +931,7 @@ def _typecheckingstub__0ebf6a0e98bbd5b88d9676fbe616666a44f837cba80675eade5df1fea
     authorized: typing.Optional[builtins.bool] = None,
     channel_name: typing.Optional[builtins.str] = None,
     latency_mode: typing.Optional[LatencyMode] = None,
+    preset: typing.Optional[Preset] = None,
     type: typing.Optional[ChannelType] = None,
 ) -> None:
     """Type checking stubs"""
@@ -882,6 +984,7 @@ def _typecheckingstub__07139327925dc97a551bbf17c849a0f698e0c9c60d3da3f65f2b3d2be
     authorized: typing.Optional[builtins.bool] = None,
     channel_name: typing.Optional[builtins.str] = None,
     latency_mode: typing.Optional[LatencyMode] = None,
+    preset: typing.Optional[Preset] = None,
     type: typing.Optional[ChannelType] = None,
 ) -> None:
     """Type checking stubs"""

aws_cdk/aws_ivs_alpha/_jsii/__init__.py

@@ -18,9 +18,9 @@ import constructs._jsii
 
 __jsii_assembly__ = jsii.JSIIAssembly.load(
     "@aws-cdk/aws-ivs-alpha",
-    "2.143.1-alpha.0",
+    "2.144.0-alpha.0",
     __name__[0:-6],
-    "aws-ivs-alpha@2.143.1-alpha.0.jsii.tgz",
+    "aws-ivs-alpha@2.144.0-alpha.0.jsii.tgz",
 )
 
 __all__ = [

{aws_cdk.aws_ivs_alpha-2.143.1a0.dist-info → aws_cdk.aws_ivs_alpha-2.144.0a0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aws-cdk.aws-ivs-alpha
-Version: 2.143.1a0
+Version: 2.144.0a0
 Summary: The CDK Construct Library for AWS::IVS
 Home-page: https://github.com/aws/aws-cdk
 Author: Amazon Web Services
@@ -23,7 +23,7 @@ Requires-Python: ~=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: NOTICE
-Requires-Dist: aws-cdk-lib <3.0.0,>=2.143.1
+Requires-Dist: aws-cdk-lib <3.0.0,>=2.144.0
 Requires-Dist: constructs <11.0.0,>=10.0.0
 Requires-Dist: jsii <2.0.0,>=1.98.0
 Requires-Dist: publication >=0.0.3
@@ -69,6 +69,22 @@ You can create a channel
 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
+)
+```
+
 ### Importing an existing channel
 
 You can reference an existing channel, for example, if you need to create a

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

@@ -0,0 +1,10 @@
+aws_cdk/aws_ivs_alpha/__init__.py,sha256=l-pcKM1wJqzDvOaZ0SC7yTQQozckqpvajIM_4BkCvZY,36420
+aws_cdk/aws_ivs_alpha/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+aws_cdk/aws_ivs_alpha/_jsii/__init__.py,sha256=vc56Oac_G0wf-n5qdNkjOpenOhQ5PMGH8gsCiisT1_o,511
+aws_cdk/aws_ivs_alpha/_jsii/aws-ivs-alpha@2.144.0-alpha.0.jsii.tgz,sha256=4dieBe60u0bBCGYM3v0YSUyLiH66mEMDENGLvAb_jHs,37183
+aws_cdk.aws_ivs_alpha-2.144.0a0.dist-info/LICENSE,sha256=kEDF86xJUQh1E9M7UPKKbHepBEdFxIUyoGfTwQB7zKg,11391
+aws_cdk.aws_ivs_alpha-2.144.0a0.dist-info/METADATA,sha256=aRFUvLxpCKp3cRZMBHWBgm9YxX71ugkQDosFkxUov2c,4960
+aws_cdk.aws_ivs_alpha-2.144.0a0.dist-info/NOTICE,sha256=dXf56qvx2VDNCaqiRscOD2IH5GbmqbnKRzroZCeLtaQ,113
+aws_cdk.aws_ivs_alpha-2.144.0a0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+aws_cdk.aws_ivs_alpha-2.144.0a0.dist-info/top_level.txt,sha256=1TALAKbuUGsMSrfKWEf268lySCmcqSEO6cDYe_XlLHM,8
+aws_cdk.aws_ivs_alpha-2.144.0a0.dist-info/RECORD,,

{aws_cdk.aws_ivs_alpha-2.143.1a0.dist-info → aws_cdk.aws_ivs_alpha-2.144.0a0.dist-info}/WHEEL

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

aws_cdk.aws_ivs_alpha-2.143.1a0.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=F0Y1UP4V0JIk79H_tzwIJqOsOWBXM6EDttM3vmZtLMY,511
-aws_cdk/aws_ivs_alpha/_jsii/aws-ivs-alpha@2.143.1-alpha.0.jsii.tgz,sha256=NfkUkOwUbwnV5otn8YNojr1FeKsVcsSX8YMFAPnUFVY,33600
-aws_cdk.aws_ivs_alpha-2.143.1a0.dist-info/LICENSE,sha256=kEDF86xJUQh1E9M7UPKKbHepBEdFxIUyoGfTwQB7zKg,11391
-aws_cdk.aws_ivs_alpha-2.143.1a0.dist-info/METADATA,sha256=93QoquwAMM4JyuKFU_EBXsCbHEN_t5uqlmBMlHOC9PA,4351
-aws_cdk.aws_ivs_alpha-2.143.1a0.dist-info/NOTICE,sha256=dXf56qvx2VDNCaqiRscOD2IH5GbmqbnKRzroZCeLtaQ,113
-aws_cdk.aws_ivs_alpha-2.143.1a0.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
-aws_cdk.aws_ivs_alpha-2.143.1a0.dist-info/top_level.txt,sha256=1TALAKbuUGsMSrfKWEf268lySCmcqSEO6cDYe_XlLHM,8
-aws_cdk.aws_ivs_alpha-2.143.1a0.dist-info/RECORD,,