Package software.amazon.awscdk.services.ivs
package software.amazon.awscdk.services.ivs
AWS::IVS Construct Library
This module is part of the AWS Cloud Development Kit project.
import software.amazon.awscdk.services.ivs.*;
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:
@aws-cdk/aws-ivs-alpha
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.)
-
ClassDescriptionThe
AWS::IVS::Channelresource specifies an channel.A fluent builder forCfnChannel.A complex type that specifies multitrack input configuration.A builder forCfnChannel.MultitrackInputConfigurationPropertyAn implementation forCfnChannel.MultitrackInputConfigurationPropertyProperties for defining aCfnChannel.A builder forCfnChannelPropsAn implementation forCfnChannelPropsTheAWS::IVS::EncoderConfigurationresource specifies an encoder configuration.A fluent builder forCfnEncoderConfiguration.The Video property type describes a stream's video configuration.A builder forCfnEncoderConfiguration.VideoPropertyAn implementation forCfnEncoderConfiguration.VideoPropertyProperties for defining aCfnEncoderConfiguration.A builder forCfnEncoderConfigurationPropsAn implementation forCfnEncoderConfigurationPropsTheAWS::IVS::IngestConfigurationresource specifies an ingest protocol to be used for a stage.A fluent builder forCfnIngestConfiguration.Properties for defining aCfnIngestConfiguration.A builder forCfnIngestConfigurationPropsAn implementation forCfnIngestConfigurationPropsTheAWS::IVS::PlaybackKeyPairresource specifies an playback key pair.A fluent builder forCfnPlaybackKeyPair.Properties for defining aCfnPlaybackKeyPair.A builder forCfnPlaybackKeyPairPropsAn implementation forCfnPlaybackKeyPairPropsTheAWS::IVS::PlaybackRestrictionPolicyresource specifies an playback restriction policy.A fluent builder forCfnPlaybackRestrictionPolicy.Properties for defining aCfnPlaybackRestrictionPolicy.A builder forCfnPlaybackRestrictionPolicyPropsAn implementation forCfnPlaybackRestrictionPolicyPropsTheAWS::IVS::PublicKeyresource specifies an Amazon IVS public key used to sign stage participant tokens.A fluent builder forCfnPublicKey.Properties for defining aCfnPublicKey.A builder forCfnPublicKeyPropsAn implementation forCfnPublicKeyPropsTheAWS::IVS::RecordingConfigurationresource specifies an recording configuration.A fluent builder forCfnRecordingConfiguration.The DestinationConfiguration property type describes the location where recorded videos will be stored.An implementation forCfnRecordingConfiguration.DestinationConfigurationPropertyThe RenditionConfiguration property type describes which renditions should be recorded for a stream.A builder forCfnRecordingConfiguration.RenditionConfigurationPropertyAn implementation forCfnRecordingConfiguration.RenditionConfigurationPropertyThe S3DestinationConfiguration property type describes an S3 location where recorded videos will be stored.An implementation forCfnRecordingConfiguration.S3DestinationConfigurationPropertyThe ThumbnailConfiguration property type describes a configuration of thumbnails for recorded video.A builder forCfnRecordingConfiguration.ThumbnailConfigurationPropertyAn implementation forCfnRecordingConfiguration.ThumbnailConfigurationPropertyProperties for defining aCfnRecordingConfiguration.A builder forCfnRecordingConfigurationPropsAn implementation forCfnRecordingConfigurationPropsTheAWS::IVS::Stageresource specifies an stage.TheAWS::IVS::AutoParticipantRecordingConfigurationproperty type describes a configuration for individual participant recording.A builder forCfnStage.AutoParticipantRecordingConfigurationPropertyAn implementation forCfnStage.AutoParticipantRecordingConfigurationPropertyA fluent builder forCfnStage.Object specifying an HLS configuration for individual participant recording.A builder forCfnStage.HlsConfigurationPropertyAn implementation forCfnStage.HlsConfigurationPropertyObject specifying a configuration of participant HLS recordings for individual participant recording.A builder forCfnStage.ParticipantRecordingHlsConfigurationPropertyAn implementation forCfnStage.ParticipantRecordingHlsConfigurationPropertyObject specifying a configuration of thumbnails for recorded video from an individual participant.A builder forCfnStage.ParticipantThumbnailConfigurationPropertyAn implementation forCfnStage.ParticipantThumbnailConfigurationPropertyAn object representing a configuration of thumbnails for recorded video.A builder forCfnStage.ThumbnailConfigurationPropertyAn implementation forCfnStage.ThumbnailConfigurationPropertyProperties for defining aCfnStage.A builder forCfnStagePropsAn implementation forCfnStagePropsTheAWS::IVS::StorageConfigurationresource specifies an storage configuration.A fluent builder forCfnStorageConfiguration.The S3StorageConfiguration property type describes an S3 location where recorded videos will be stored.A builder forCfnStorageConfiguration.S3StorageConfigurationPropertyAn implementation forCfnStorageConfiguration.S3StorageConfigurationPropertyProperties for defining aCfnStorageConfiguration.A builder forCfnStorageConfigurationPropsAn implementation forCfnStorageConfigurationPropsTheAWS::IVS::StreamKeyresource specifies an stream key associated with the referenced channel.A fluent builder forCfnStreamKey.Properties for defining aCfnStreamKey.A builder forCfnStreamKeyPropsAn implementation forCfnStreamKeyPropsA reference to a Channel resource.A builder forChannelReferenceAn implementation forChannelReferenceA reference to a EncoderConfiguration resource.A builder forEncoderConfigurationReferenceAn implementation forEncoderConfigurationReference(experimental) Indicates that this resource can be referenced as a Channel.Internal default implementation forIChannelRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a EncoderConfiguration.Internal default implementation forIEncoderConfigurationRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a IngestConfiguration.Internal default implementation forIIngestConfigurationRef.A proxy class which represents a concrete javascript instance of this type.A reference to a IngestConfiguration resource.A builder forIngestConfigurationReferenceAn implementation forIngestConfigurationReference(experimental) Indicates that this resource can be referenced as a PlaybackKeyPair.Internal default implementation forIPlaybackKeyPairRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a PlaybackRestrictionPolicy.Internal default implementation forIPlaybackRestrictionPolicyRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a PublicKey.Internal default implementation forIPublicKeyRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a RecordingConfiguration.Internal default implementation forIRecordingConfigurationRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a Stage.Internal default implementation forIStageRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a StorageConfiguration.Internal default implementation forIStorageConfigurationRef.A proxy class which represents a concrete javascript instance of this type.(experimental) Indicates that this resource can be referenced as a StreamKey.Internal default implementation forIStreamKeyRef.A proxy class which represents a concrete javascript instance of this type.A reference to a PlaybackKeyPair resource.A builder forPlaybackKeyPairReferenceAn implementation forPlaybackKeyPairReferenceA reference to a PlaybackRestrictionPolicy resource.A builder forPlaybackRestrictionPolicyReferenceAn implementation forPlaybackRestrictionPolicyReferenceA reference to a PublicKey resource.A builder forPublicKeyReferenceAn implementation forPublicKeyReferenceA reference to a RecordingConfiguration resource.A builder forRecordingConfigurationReferenceAn implementation forRecordingConfigurationReferenceA reference to a Stage resource.A builder forStageReferenceAn implementation forStageReferenceA reference to a StorageConfiguration resource.A builder forStorageConfigurationReferenceAn implementation forStorageConfigurationReferenceA reference to a StreamKey resource.A builder forStreamKeyReferenceAn implementation forStreamKeyReference