AWS::IVS Construct Library

This module is part of the AWS Cloud Development Kit project.

import * as ivs from 'aws-cdk-lib/aws-ivs';

python

import aws_cdk.aws_ivs as ivs

java

import software.amazon.awscdk.services.ivs.*;

csharp

using Amazon.CDK.AWS.Ivs;

import ivs "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

Search Construct Hub for IVS construct libraries
Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::IVS resources directly.

An experimental construct library for this service is available in preview. Since it is not stable yet, it is distributed as a separate package so that you can pin its version independently of the rest of the CDK. See the package:
<span class="package-reference">@aws-cdk/aws-ivs-alpha</span>

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::IVS.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Types

Name	Kind	Summary
`CfnChannel`	Construct (L1)	The `AWS::IVS::Channel` resource specifies an channel.
`CfnEncoderConfiguration`	Construct (L1)	The `AWS::IVS::EncoderConfiguration` resource specifies an encoder configuration.
`CfnIngestConfiguration`	Construct (L1)	The `AWS::IVS::IngestConfiguration` resource specifies an ingest protocol to be used for a stage.
`CfnPlaybackKeyPair`	Construct (L1)	The `AWS::IVS::PlaybackKeyPair` resource specifies an playback key pair.
`CfnPlaybackRestrictionPolicy`	Construct (L1)	The `AWS::IVS::PlaybackRestrictionPolicy` resource specifies an playback restriction policy.
`CfnPublicKey`	Construct (L1)	The `AWS::IVS::PublicKey` resource specifies an Amazon IVS public key used to sign stage participant tokens.
`CfnRecordingConfiguration`	Construct (L1)	The `AWS::IVS::RecordingConfiguration` resource specifies an recording configuration.
`CfnStage`	Construct (L1)	The `AWS::IVS::Stage` resource specifies an stage.
`CfnStorageConfiguration`	Construct (L1)	The `AWS::IVS::StorageConfiguration` resource specifies an storage configuration.
`CfnStreamKey`	Construct (L1)	The `AWS::IVS::StreamKey` resource specifies an stream key associated with the referenced channel.
`CfnChannel.MultitrackInputConfigurationProperty`	Struct	A complex type that specifies multitrack input configuration.
`CfnChannelProps`	Struct	Properties for defining a `CfnChannel`.
`CfnEncoderConfiguration.VideoProperty`	Struct	The Video property type describes a stream's video configuration.
`CfnEncoderConfigurationProps`	Struct	Properties for defining a `CfnEncoderConfiguration`.
`CfnIngestConfigurationProps`	Struct	Properties for defining a `CfnIngestConfiguration`.
`CfnPlaybackKeyPairProps`	Struct	Properties for defining a `CfnPlaybackKeyPair`.
`CfnPlaybackRestrictionPolicyProps`	Struct	Properties for defining a `CfnPlaybackRestrictionPolicy`.
`CfnPublicKeyProps`	Struct	Properties for defining a `CfnPublicKey`.
`CfnRecordingConfiguration.DestinationConfigurationProperty`	Struct	The DestinationConfiguration property type describes the location where recorded videos will be stored.
`CfnRecordingConfiguration.RenditionConfigurationProperty`	Struct	The RenditionConfiguration property type describes which renditions should be recorded for a stream.
`CfnRecordingConfiguration.S3DestinationConfigurationProperty`	Struct	The S3DestinationConfiguration property type describes an S3 location where recorded videos will be stored.
`CfnRecordingConfiguration.ThumbnailConfigurationProperty`	Struct	The ThumbnailConfiguration property type describes a configuration of thumbnails for recorded video.
`CfnRecordingConfigurationProps`	Struct	Properties for defining a `CfnRecordingConfiguration`.
`CfnStage.AutoParticipantRecordingConfigurationProperty`	Struct	The `AWS::IVS::AutoParticipantRecordingConfiguration` property type describes a configuration for individual participant recording.
`CfnStage.HlsConfigurationProperty`	Struct	Object specifying an HLS configuration for individual participant recording.
`CfnStage.ParticipantRecordingHlsConfigurationProperty`	Struct	Object specifying a configuration of participant HLS recordings for individual participant recording.
`CfnStage.ParticipantThumbnailConfigurationProperty`	Struct	Object specifying a configuration of thumbnails for recorded video from an individual participant.
`CfnStage.ThumbnailConfigurationProperty`	Struct	An object representing a configuration of thumbnails for recorded video.
`CfnStageProps`	Struct	Properties for defining a `CfnStage`.
`CfnStorageConfiguration.S3StorageConfigurationProperty`	Struct	The S3StorageConfiguration property type describes an S3 location where recorded videos will be stored.
`CfnStorageConfigurationProps`	Struct	Properties for defining a `CfnStorageConfiguration`.
`CfnStreamKeyProps`	Struct	Properties for defining a `CfnStreamKey`.

AWS::IVS Construct Library ​

Types ​

AWS::IVS Construct Library

Types