AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::IVS::RecordingConfiguration

CfnRecordingConfiguration

The `AWS::IVS::RecordingConfiguration` resource specifies an recording configuration. A recording configuration enables the recording of a channel’s live streams to a data store. Multiple channels can reference the same recording configuration. For more information, see [RecordingConfiguration](https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/API_RecordingConfiguration.html) in the *Amazon IVS Low-Latency Streaming API Reference* .

Import

import { CfnRecordingConfiguration } from 'aws-cdk-lib/aws-ivs';

Or use the module namespace:

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

Properties

Configuration passed to the constructor as CfnRecordingConfigurationProps.

destinationConfigurationRequired
IResolvable | DestinationConfigurationProperty

A destination configuration describes an S3 bucket where recorded video will be stored. See the DestinationConfiguration property type for more information.

nameOptional
string

Recording-configuration name. The value does not need to be unique.

recordingReconnectWindowSecondsOptional
number

If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. *Default* : `0`

Default: - 0

renditionConfigurationOptional
IResolvable | RenditionConfigurationProperty

A rendition configuration describes which renditions should be recorded for a stream. See the RenditionConfiguration property type for more information.

tagsOptional
CfnTag[]

An array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-tag.html) .

thumbnailConfigurationOptional
IResolvable | ThumbnailConfigurationProperty

A thumbnail configuration enables/disables the recording of thumbnails for a live session and controls the interval at which thumbnails are generated for the live session. See the ThumbnailConfiguration property type for more information.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::IVS::RecordingConfigurationView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-ivs
CFN TypeAWS::IVS::RecordingConfiguration
Properties6

Related Constructs

Explore This Service

External Links