Metadata-Version: 2.1
Name: aws-cdk.aws-ivs
Version: 1.81.0
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
Description: # AWS::IVS Construct Library
        
        <!--BEGIN STABILITY BANNER-->---
        
        
        ![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)
        
        > All classes with the `Cfn` prefix in this module ([CFN Resources](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) are always stable and safe to use.
        
        ![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
        # Example automatically generated. See https://github.com/aws/jsii/issues/826
        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
        # Example automatically generated. See https://github.com/aws/jsii/issues/826
        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
        # Example automatically generated. See https://github.com/aws/jsii/issues/826
        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
        # Example automatically generated. See https://github.com/aws/jsii/issues/826
        key_pair = ivs.PlaybackKeyPair(self, "PlaybackKeyPair",
            public_key_material=my_public_key_pem_string
        )
        ```
        
        Then, when creating a channel, specify the authorized property
        
        ```python
        # Example automatically generated. See https://github.com/aws/jsii/issues/826
        my_channel = ivs.Channel(self, "Channel",
            authorized=True
        )
        ```
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: JavaScript
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Typing :: Typed
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved
Classifier: Framework :: AWS CDK
Classifier: Framework :: AWS CDK :: 1
Requires-Python: >=3.6
Description-Content-Type: text/markdown
