software.amazon.awssdk.services.nimble.model

Interface StreamConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

StreamConfiguration

public static interface StreamConfiguration.Builder
extends SdkPojo, CopyableBuilder<StreamConfiguration.Builder,StreamConfiguration>

Method Summary

Modifier and Type	Method and Description
StreamConfiguration.Builder	clipboardMode(StreamingClipboardMode clipboardMode) Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
StreamConfiguration.Builder	clipboardMode(String clipboardMode) Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
StreamConfiguration.Builder	ec2InstanceTypes(Collection<StreamingInstanceType> ec2InstanceTypes) The EC2 instance types that users can select from when launching a streaming session with this launch profile.
StreamConfiguration.Builder	ec2InstanceTypes(StreamingInstanceType... ec2InstanceTypes) The EC2 instance types that users can select from when launching a streaming session with this launch profile.
StreamConfiguration.Builder	ec2InstanceTypesWithStrings(Collection<String> ec2InstanceTypes) The EC2 instance types that users can select from when launching a streaming session with this launch profile.
StreamConfiguration.Builder	ec2InstanceTypesWithStrings(String... ec2InstanceTypes) The EC2 instance types that users can select from when launching a streaming session with this launch profile.
StreamConfiguration.Builder	maxSessionLengthInMinutes(Integer maxSessionLengthInMinutes) The length of time, in minutes, that a streaming session can be active before it is stopped or terminated.
StreamConfiguration.Builder	maxStoppedSessionLengthInMinutes(Integer maxStoppedSessionLengthInMinutes) Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state.
default StreamConfiguration.Builder	sessionStorage(Consumer<StreamConfigurationSessionStorage.Builder> sessionStorage) (Optional) The upload storage for a streaming session.
StreamConfiguration.Builder	sessionStorage(StreamConfigurationSessionStorage sessionStorage) (Optional) The upload storage for a streaming session.
StreamConfiguration.Builder	streamingImageIds(Collection<String> streamingImageIds) The streaming images that users can select from when launching a streaming session with this launch profile.
StreamConfiguration.Builder	streamingImageIds(String... streamingImageIds) The streaming images that users can select from when launching a streaming session with this launch profile.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

clipboardMode

StreamConfiguration.Builder clipboardMode(String clipboardMode)

Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.

Parameters:

clipboardMode - Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.

Returns:

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

See Also:

StreamingClipboardMode, StreamingClipboardMode

clipboardMode

StreamConfiguration.Builder clipboardMode(StreamingClipboardMode clipboardMode)

Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.

Parameters:

clipboardMode - Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.

Returns:

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

See Also:

StreamingClipboardMode, StreamingClipboardMode

ec2InstanceTypesWithStrings

StreamConfiguration.Builder ec2InstanceTypesWithStrings(Collection<String> ec2InstanceTypes)

The EC2 instance types that users can select from when launching a streaming session with this launch profile.

Parameters:

ec2InstanceTypes - The EC2 instance types that users can select from when launching a streaming session with this launch profile.

Returns:

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

ec2InstanceTypesWithStrings

StreamConfiguration.Builder ec2InstanceTypesWithStrings(String... ec2InstanceTypes)

The EC2 instance types that users can select from when launching a streaming session with this launch profile.

Parameters:

ec2InstanceTypes - The EC2 instance types that users can select from when launching a streaming session with this launch profile.

Returns:

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

ec2InstanceTypes

StreamConfiguration.Builder ec2InstanceTypes(Collection<StreamingInstanceType> ec2InstanceTypes)

The EC2 instance types that users can select from when launching a streaming session with this launch profile.

Parameters:

ec2InstanceTypes - The EC2 instance types that users can select from when launching a streaming session with this launch profile.

Returns:

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

ec2InstanceTypes

StreamConfiguration.Builder ec2InstanceTypes(StreamingInstanceType... ec2InstanceTypes)

The EC2 instance types that users can select from when launching a streaming session with this launch profile.

Parameters:

ec2InstanceTypes - The EC2 instance types that users can select from when launching a streaming session with this launch profile.

Returns:

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

maxSessionLengthInMinutes

StreamConfiguration.Builder maxSessionLengthInMinutes(Integer maxSessionLengthInMinutes)

The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.

Parameters:

maxSessionLengthInMinutes - The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.

Returns:

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

maxStoppedSessionLengthInMinutes

StreamConfiguration.Builder maxStoppedSessionLengthInMinutes(Integer maxStoppedSessionLengthInMinutes)

Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.

If the value is missing or set to 0, your sessions can’t be stopped. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated by AWS (instead of stopped).

If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped by AWS (instead of terminated).

Parameters:

maxStoppedSessionLengthInMinutes - Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.

If the value is missing or set to 0, your sessions can’t be stopped. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated by AWS (instead of stopped).

If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped by AWS (instead of terminated).

Returns:

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

sessionStorage

StreamConfiguration.Builder sessionStorage(StreamConfigurationSessionStorage sessionStorage)

(Optional) The upload storage for a streaming session.

Parameters:

sessionStorage - (Optional) The upload storage for a streaming session.

Returns:

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

sessionStorage

default StreamConfiguration.Builder sessionStorage(Consumer<StreamConfigurationSessionStorage.Builder> sessionStorage)

(Optional) The upload storage for a streaming session.

This is a convenience method that creates an instance of the StreamConfigurationSessionStorage.Builder avoiding the need to create one manually via StreamConfigurationSessionStorage.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sessionStorage(StreamConfigurationSessionStorage).

Parameters:

sessionStorage - a consumer that will call methods on StreamConfigurationSessionStorage.Builder

Returns:

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

See Also:

sessionStorage(StreamConfigurationSessionStorage)

streamingImageIds

StreamConfiguration.Builder streamingImageIds(Collection<String> streamingImageIds)

The streaming images that users can select from when launching a streaming session with this launch profile.

Parameters:

streamingImageIds - The streaming images that users can select from when launching a streaming session with this launch profile.

Returns:

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

streamingImageIds

StreamConfiguration.Builder streamingImageIds(String... streamingImageIds)

The streaming images that users can select from when launching a streaming session with this launch profile.

Parameters:

streamingImageIds - The streaming images that users can select from when launching a streaming session with this launch profile.

Returns:

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