Package software.amazon.awscdk.services.ivs

Interface CfnRecordingConfigurationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRecordingConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:43.724Z")
@Stability(Stable)
public interface CfnRecordingConfigurationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRecordingConfiguration.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ivs.*;
 CfnRecordingConfigurationProps cfnRecordingConfigurationProps = CfnRecordingConfigurationProps.builder()
         .destinationConfiguration(DestinationConfigurationProperty.builder()
                 .s3(S3DestinationConfigurationProperty.builder()
                         .bucketName("bucketName")
                         .build())
                 .build())
         // the properties below are optional
         .name("name")
         .recordingReconnectWindowSeconds(123)
         .renditionConfiguration(RenditionConfigurationProperty.builder()
                 .renditions(List.of("renditions"))
                 .renditionSelection("renditionSelection")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .thumbnailConfiguration(ThumbnailConfigurationProperty.builder()
                 .recordingMode("recordingMode")
                 .resolution("resolution")
                 .storage(List.of("storage"))
                 .targetIntervalSeconds(123)
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-recordingconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRecordingConfigurationProps.Builder	A builder for CfnRecordingConfigurationProps
static final class	CfnRecordingConfigurationProps.Jsii$Proxy	An implementation for CfnRecordingConfigurationProps

Method Summary

Modifier and Type	Method	Description
static CfnRecordingConfigurationProps.Builder	builder()
Object	getDestinationConfiguration()	A destination configuration describes an S3 bucket where recorded video will be stored.
default String	getName()	Recording-configuration name.
default Number	getRecordingReconnectWindowSeconds()	If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
default Object	getRenditionConfiguration()	A rendition configuration describes which renditions should be recorded for a stream.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
default Object	getThumbnailConfiguration()	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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDestinationConfiguration

@Stability(Stable)
@NotNull
Object getDestinationConfiguration()

A destination configuration describes an S3 bucket where recorded video will be stored.

See the DestinationConfiguration property type for more information.

Returns union: either IResolvable or CfnRecordingConfiguration.DestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-recordingconfiguration.html#cfn-ivs-recordingconfiguration-destinationconfiguration

getName

@Stability(Stable)
@Nullable
default String getName()

Recording-configuration name.

The value does not need to be unique.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-recordingconfiguration.html#cfn-ivs-recordingconfiguration-name

getRecordingReconnectWindowSeconds

@Stability(Stable)
@Nullable
default Number getRecordingReconnectWindowSeconds()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-recordingconfiguration.html#cfn-ivs-recordingconfiguration-recordingreconnectwindowseconds

getRenditionConfiguration

@Stability(Stable)
@Nullable
default Object getRenditionConfiguration()

A rendition configuration describes which renditions should be recorded for a stream.

See the RenditionConfiguration property type for more information.

Returns union: either IResolvable or CfnRecordingConfiguration.RenditionConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-recordingconfiguration.html#cfn-ivs-recordingconfiguration-renditionconfiguration

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-recordingconfiguration.html#cfn-ivs-recordingconfiguration-tags

getThumbnailConfiguration

@Stability(Stable)
@Nullable
default Object getThumbnailConfiguration()

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.

Returns union: either IResolvable or CfnRecordingConfiguration.ThumbnailConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-recordingconfiguration.html#cfn-ivs-recordingconfiguration-thumbnailconfiguration

builder

@Stability(Stable)
static CfnRecordingConfigurationProps.Builder builder()

Returns:

a CfnRecordingConfigurationProps.Builder of CfnRecordingConfigurationProps