Interface RecordingConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<RecordingConfiguration.Builder,RecordingConfiguration>, SdkBuilder<RecordingConfiguration.Builder,RecordingConfiguration>, SdkPojo

Enclosing class:

RecordingConfiguration

@Mutable
@NotThreadSafe
public static interface RecordingConfiguration.Builder
extends SdkPojo, CopyableBuilder<RecordingConfiguration.Builder,RecordingConfiguration>

Method Summary

Modifier and Type	Method	Description
RecordingConfiguration.Builder	arn(String arn)	Recording-configuration ARN.
default RecordingConfiguration.Builder	destinationConfiguration(Consumer<DestinationConfiguration.Builder> destinationConfiguration)	A complex type that contains information about where recorded video will be stored.
RecordingConfiguration.Builder	destinationConfiguration(DestinationConfiguration destinationConfiguration)	A complex type that contains information about where recorded video will be stored.
RecordingConfiguration.Builder	name(String name)	Recording-configuration name.
RecordingConfiguration.Builder	recordingReconnectWindowSeconds(Integer recordingReconnectWindowSeconds)	If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
default RecordingConfiguration.Builder	renditionConfiguration(Consumer<RenditionConfiguration.Builder> renditionConfiguration)	Object that describes which renditions should be recorded for a stream.
RecordingConfiguration.Builder	renditionConfiguration(RenditionConfiguration renditionConfiguration)	Object that describes which renditions should be recorded for a stream.
RecordingConfiguration.Builder	state(String state)	Indicates the current state of the recording configuration.
RecordingConfiguration.Builder	state(RecordingConfigurationState state)	Indicates the current state of the recording configuration.
RecordingConfiguration.Builder	tags(Map<String,String> tags)	Tags attached to the resource.
default RecordingConfiguration.Builder	thumbnailConfiguration(Consumer<ThumbnailConfiguration.Builder> thumbnailConfiguration)	A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.
RecordingConfiguration.Builder	thumbnailConfiguration(ThumbnailConfiguration thumbnailConfiguration)	A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

arn

RecordingConfiguration.Builder arn(String arn)

Recording-configuration ARN.

Parameters:

arn - Recording-configuration ARN.

Returns:

Returns a reference to this object so that method calls can be chained together.

destinationConfiguration

RecordingConfiguration.Builder destinationConfiguration(DestinationConfiguration destinationConfiguration)

A complex type that contains information about where recorded video will be stored.

Parameters:

destinationConfiguration - A complex type that contains information about where recorded video will be stored.

Returns:

Returns a reference to this object so that method calls can be chained together.

destinationConfiguration

default RecordingConfiguration.Builder destinationConfiguration(Consumer<DestinationConfiguration.Builder> destinationConfiguration)

A complex type that contains information about where recorded video will be stored.

This is a convenience method that creates an instance of the DestinationConfiguration.Builder avoiding the need to create one manually via DestinationConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destinationConfiguration(DestinationConfiguration).

Parameters:

destinationConfiguration - a consumer that will call methods on DestinationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• destinationConfiguration(DestinationConfiguration)

name

RecordingConfiguration.Builder name(String name)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

recordingReconnectWindowSeconds

RecordingConfiguration.Builder recordingReconnectWindowSeconds(Integer recordingReconnectWindowSeconds)

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.

Parameters:

recordingReconnectWindowSeconds - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

renditionConfiguration

RecordingConfiguration.Builder renditionConfiguration(RenditionConfiguration renditionConfiguration)

Object that describes which renditions should be recorded for a stream.

Parameters:

renditionConfiguration - Object that describes which renditions should be recorded for a stream.

Returns:

Returns a reference to this object so that method calls can be chained together.

renditionConfiguration

default RecordingConfiguration.Builder renditionConfiguration(Consumer<RenditionConfiguration.Builder> renditionConfiguration)

Object that describes which renditions should be recorded for a stream.

This is a convenience method that creates an instance of the RenditionConfiguration.Builder avoiding the need to create one manually via RenditionConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to renditionConfiguration(RenditionConfiguration).

Parameters:

renditionConfiguration - a consumer that will call methods on RenditionConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• renditionConfiguration(RenditionConfiguration)

state

RecordingConfiguration.Builder state(String state)

Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

Parameters:

state - Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• RecordingConfigurationState
• RecordingConfigurationState

state

RecordingConfiguration.Builder state(RecordingConfigurationState state)

Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

Parameters:

state - Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• RecordingConfigurationState
• RecordingConfigurationState

tags

RecordingConfiguration.Builder tags(Map<String,String> tags)

Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Parameters:

tags - Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Returns:

Returns a reference to this object so that method calls can be chained together.

thumbnailConfiguration

RecordingConfiguration.Builder thumbnailConfiguration(ThumbnailConfiguration thumbnailConfiguration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

thumbnailConfiguration

default RecordingConfiguration.Builder thumbnailConfiguration(Consumer<ThumbnailConfiguration.Builder> thumbnailConfiguration)

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

This is a convenience method that creates an instance of the ThumbnailConfiguration.Builder avoiding the need to create one manually via ThumbnailConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to thumbnailConfiguration(ThumbnailConfiguration).

Parameters:

thumbnailConfiguration - a consumer that will call methods on ThumbnailConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• thumbnailConfiguration(ThumbnailConfiguration)