AWS::IVS::Stage AutoParticipantRecordingConfiguration

The AWS::IVS::AutoParticipantRecordingConfiguration property type describes a configuration for individual participant recording.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "HlsConfiguration" : HlsConfiguration,
  "MediaTypes" : [ String, ... ],
  "RecordingReconnectWindowSeconds" : Integer,
  "StorageConfigurationArn" : String,
  "ThumbnailConfiguration" : ThumbnailConfiguration
}

YAML

  HlsConfiguration: 
    HlsConfiguration
  MediaTypes: 
    - String
  RecordingReconnectWindowSeconds: Integer
  StorageConfigurationArn: String
  ThumbnailConfiguration: 
    ThumbnailConfiguration

Properties

HlsConfiguration

HLS configuration object for individual participant recording.

Required: No

Type: HlsConfiguration

Update requires: No interruption

MediaTypes

Types of media to be recorded. Default: AUDIO_VIDEO.

Required: No

Type: Array of String

Allowed values: AUDIO_VIDEO | AUDIO_ONLY

Minimum: 0

Maximum: 1

Update requires: No interruption

RecordingReconnectWindowSeconds

If a stage publisher disconnects and then reconnects within the specified interval, the multiple recordings will be considered a single recording and merged together.

The default value is 0, which disables merging.

Required: No

Type: Integer

Minimum: 0

Maximum: 300

Update requires: No interruption

StorageConfigurationArn

ARN of the StorageConfiguration resource to use for individual participant recording. Default: "" (empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a Stage is created or updated.

Required: Yes

Type: String

Pattern: ^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:storage-configuration/[a-zA-Z0-9-]+$

Minimum: 0

Maximum: 128

Update requires: No interruption

ThumbnailConfiguration

A complex type that allows you to enable/disable the recording of thumbnails for individual participant recording and modify the interval at which thumbnails are generated for the live session.

Required: No

Type: ThumbnailConfiguration

Update requires: No interruption