Package software.amazon.awscdk.services.ivs.alpha

Class RecordingConfiguration.Builder

java.lang.Object

software.amazon.awscdk.services.ivs.alpha.RecordingConfiguration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<RecordingConfiguration>

Enclosing class:

RecordingConfiguration

@Stability(Experimental)
public static final class RecordingConfiguration.Builder
extends Object
implements software.amazon.jsii.Builder<RecordingConfiguration>

(experimental) A fluent builder for RecordingConfiguration.

Method Summary

Modifier and Type	Method	Description
RecordingConfiguration.Builder	bucket(IBucketRef bucket)	(experimental) S3 bucket where recorded videos will be stored.
RecordingConfiguration	build()
static RecordingConfiguration.Builder	create(software.constructs.Construct scope, String id)
RecordingConfiguration.Builder	recordingConfigurationName(String recordingConfigurationName)	(experimental) The name of the Recording configuration.
RecordingConfiguration.Builder	recordingReconnectWindow(Duration recordingReconnectWindow)	(experimental) If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
RecordingConfiguration.Builder	renditionConfiguration(RenditionConfiguration renditionConfiguration)	(experimental) A rendition configuration describes which renditions should be recorded for a stream.
RecordingConfiguration.Builder	thumbnailConfiguration(ThumbnailConfiguration thumbnailConfiguration)	(experimental) 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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Experimental)
public static RecordingConfiguration.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of RecordingConfiguration.Builder.

bucket

@Stability(Experimental)
public RecordingConfiguration.Builder bucket(IBucketRef bucket)

(experimental) S3 bucket where recorded videos will be stored.

Parameters:

bucket - S3 bucket where recorded videos will be stored. This parameter is required.

Returns:

this

recordingConfigurationName

@Stability(Experimental)
public RecordingConfiguration.Builder recordingConfigurationName(String recordingConfigurationName)

(experimental) The name of the Recording configuration.

The value does not need to be unique.

Default: - auto generate

Parameters:

recordingConfigurationName - The name of the Recording configuration. This parameter is required.

Returns:

this

recordingReconnectWindow

@Stability(Experimental)
public RecordingConfiguration.Builder recordingReconnectWindow(Duration recordingReconnectWindow)

(experimental) If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.

recordingReconnectWindow must be between 0 and 300 seconds

Default: - 0 seconds (means disabled)

Parameters:

recordingReconnectWindow - If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. This parameter is required.

Returns:

this

renditionConfiguration

@Stability(Experimental)
public RecordingConfiguration.Builder renditionConfiguration(RenditionConfiguration renditionConfiguration)

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

Default: - no rendition configuration

Parameters:

renditionConfiguration - A rendition configuration describes which renditions should be recorded for a stream. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-renditionconfiguration.html

thumbnailConfiguration

@Stability(Experimental)
public RecordingConfiguration.Builder thumbnailConfiguration(ThumbnailConfiguration thumbnailConfiguration)

(experimental) 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.

Default: - no thumbnail configuration

Parameters:

thumbnailConfiguration - 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. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html

build

@Stability(Experimental)
public RecordingConfiguration build()

Specified by:

build in interface software.amazon.jsii.Builder<RecordingConfiguration>

Returns:

a newly built instance of RecordingConfiguration.