Interface StreamConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<StreamConfiguration.Builder,
,StreamConfiguration> SdkBuilder<StreamConfiguration.Builder,
,StreamConfiguration> SdkPojo
- Enclosing class:
StreamConfiguration
-
Method Summary
Modifier and TypeMethodDescriptionautomaticTerminationMode
(String automaticTerminationMode) Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in aSTOPPED
state.automaticTerminationMode
(AutomaticTerminationMode automaticTerminationMode) Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in aSTOPPED
state.clipboardMode
(String clipboardMode) Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.clipboardMode
(StreamingClipboardMode clipboardMode) Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.ec2InstanceTypes
(Collection<StreamingInstanceType> ec2InstanceTypes) The EC2 instance types that users can select from when launching a streaming session with this launch profile.ec2InstanceTypes
(StreamingInstanceType... ec2InstanceTypes) The EC2 instance types that users can select from when launching a streaming session with this launch profile.ec2InstanceTypesWithStrings
(String... ec2InstanceTypes) The EC2 instance types that users can select from when launching a streaming session with this launch profile.ec2InstanceTypesWithStrings
(Collection<String> ec2InstanceTypes) The EC2 instance types that users can select from when launching a streaming session with this launch profile.maxSessionLengthInMinutes
(Integer maxSessionLengthInMinutes) The length of time, in minutes, that a streaming session can be active before it is stopped or terminated.maxStoppedSessionLengthInMinutes
(Integer maxStoppedSessionLengthInMinutes) Integer that determines if you can start and stop your sessions and how long a session can stay in theSTOPPED
state.default StreamConfiguration.Builder
sessionBackup
(Consumer<StreamConfigurationSessionBackup.Builder> sessionBackup) Information about the streaming session backup.sessionBackup
(StreamConfigurationSessionBackup sessionBackup) Information about the streaming session backup.sessionPersistenceMode
(String sessionPersistenceMode) Determine if a streaming session created from this launch profile can configure persistent storage.sessionPersistenceMode
(SessionPersistenceMode sessionPersistenceMode) Determine if a streaming session created from this launch profile can configure persistent storage.default StreamConfiguration.Builder
sessionStorage
(Consumer<StreamConfigurationSessionStorage.Builder> sessionStorage) The upload storage for a streaming session.sessionStorage
(StreamConfigurationSessionStorage sessionStorage) The upload storage for a streaming session.streamingImageIds
(String... streamingImageIds) The streaming images that users can select from when launching a streaming session with this launch profile.streamingImageIds
(Collection<String> streamingImageIds) The streaming images that users can select from when launching a streaming session with this launch profile.default StreamConfiguration.Builder
volumeConfiguration
(Consumer<VolumeConfiguration.Builder> volumeConfiguration) Custom volume configuration for the root volumes that are attached to streaming sessions.volumeConfiguration
(VolumeConfiguration volumeConfiguration) Custom volume configuration for the root volumes that are attached to streaming sessions.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, sdkFields
-
Method Details
-
automaticTerminationMode
Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a
STOPPED
state.-
When
ACTIVATED
, the streaming session is scheduled for termination after being in theSTOPPED
state for the time specified inmaxStoppedSessionLengthInMinutes
. -
When
DEACTIVATED
, the streaming session can remain in theSTOPPED
state indefinitely.
This parameter is only allowed when
sessionPersistenceMode
isACTIVATED
. When allowed, the default value for this parameter isDEACTIVATED
.- Parameters:
automaticTerminationMode
- Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in aSTOPPED
state.-
When
ACTIVATED
, the streaming session is scheduled for termination after being in theSTOPPED
state for the time specified inmaxStoppedSessionLengthInMinutes
. -
When
DEACTIVATED
, the streaming session can remain in theSTOPPED
state indefinitely.
This parameter is only allowed when
sessionPersistenceMode
isACTIVATED
. When allowed, the default value for this parameter isDEACTIVATED
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
automaticTerminationMode
StreamConfiguration.Builder automaticTerminationMode(AutomaticTerminationMode automaticTerminationMode) Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a
STOPPED
state.-
When
ACTIVATED
, the streaming session is scheduled for termination after being in theSTOPPED
state for the time specified inmaxStoppedSessionLengthInMinutes
. -
When
DEACTIVATED
, the streaming session can remain in theSTOPPED
state indefinitely.
This parameter is only allowed when
sessionPersistenceMode
isACTIVATED
. When allowed, the default value for this parameter isDEACTIVATED
.- Parameters:
automaticTerminationMode
- Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in aSTOPPED
state.-
When
ACTIVATED
, the streaming session is scheduled for termination after being in theSTOPPED
state for the time specified inmaxStoppedSessionLengthInMinutes
. -
When
DEACTIVATED
, the streaming session can remain in theSTOPPED
state indefinitely.
This parameter is only allowed when
sessionPersistenceMode
isACTIVATED
. When allowed, the default value for this parameter isDEACTIVATED
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
clipboardMode
Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
- Parameters:
clipboardMode
- Allows or deactivates 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:
-
clipboardMode
Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
- Parameters:
clipboardMode
- Allows or deactivates 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:
-
ec2InstanceTypesWithStrings
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
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
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
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
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.This field is allowed only when
sessionPersistenceMode
isACTIVATED
andautomaticTerminationMode
isACTIVATED
.If the value is set to 0, your sessions can’t be
STOPPED
. If you then callStopStreamingSession
, the session fails. If the time that a session stays in theREADY
state exceeds themaxSessionLengthInMinutes
value, the session will automatically be terminated (instead ofSTOPPED
).If the value is set to a positive number, the session can be stopped. You can call
StopStreamingSession
to stop sessions in theREADY
state. If the time that a session stays in theREADY
state exceeds themaxSessionLengthInMinutes
value, the session will automatically be stopped (instead of terminated).- Parameters:
maxStoppedSessionLengthInMinutes
- Integer that determines if you can start and stop your sessions and how long a session can stay in theSTOPPED
state. The default value is 0. The maximum value is 5760.This field is allowed only when
sessionPersistenceMode
isACTIVATED
andautomaticTerminationMode
isACTIVATED
.If the value is set to 0, your sessions can’t be
STOPPED
. If you then callStopStreamingSession
, the session fails. If the time that a session stays in theREADY
state exceeds themaxSessionLengthInMinutes
value, the session will automatically be terminated (instead ofSTOPPED
).If the value is set to a positive number, the session can be stopped. You can call
StopStreamingSession
to stop sessions in theREADY
state. If the time that a session stays in theREADY
state exceeds themaxSessionLengthInMinutes
value, the session will automatically be stopped (instead of terminated).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sessionBackup
Information about the streaming session backup.
- Parameters:
sessionBackup
- Information about the streaming session backup.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sessionBackup
default StreamConfiguration.Builder sessionBackup(Consumer<StreamConfigurationSessionBackup.Builder> sessionBackup) Information about the streaming session backup.
This is a convenience method that creates an instance of theStreamConfigurationSessionBackup.Builder
avoiding the need to create one manually viaStreamConfigurationSessionBackup.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosessionBackup(StreamConfigurationSessionBackup)
.- Parameters:
sessionBackup
- a consumer that will call methods onStreamConfigurationSessionBackup.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sessionPersistenceMode
Determine if a streaming session created from this launch profile can configure persistent storage. This means that
volumeConfiguration
andautomaticTerminationMode
are configured.- Parameters:
sessionPersistenceMode
- Determine if a streaming session created from this launch profile can configure persistent storage. This means thatvolumeConfiguration
andautomaticTerminationMode
are configured.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sessionPersistenceMode
Determine if a streaming session created from this launch profile can configure persistent storage. This means that
volumeConfiguration
andautomaticTerminationMode
are configured.- Parameters:
sessionPersistenceMode
- Determine if a streaming session created from this launch profile can configure persistent storage. This means thatvolumeConfiguration
andautomaticTerminationMode
are configured.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sessionStorage
The upload storage for a streaming session.
- Parameters:
sessionStorage
- 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) The upload storage for a streaming session.
This is a convenience method that creates an instance of theStreamConfigurationSessionStorage.Builder
avoiding the need to create one manually viaStreamConfigurationSessionStorage.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosessionStorage(StreamConfigurationSessionStorage)
.- Parameters:
sessionStorage
- a consumer that will call methods onStreamConfigurationSessionStorage.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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.
-
volumeConfiguration
Custom volume configuration for the root volumes that are attached to streaming sessions.
This parameter is only allowed when
sessionPersistenceMode
isACTIVATED
.- Parameters:
volumeConfiguration
- Custom volume configuration for the root volumes that are attached to streaming sessions.This parameter is only allowed when
sessionPersistenceMode
isACTIVATED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
volumeConfiguration
default StreamConfiguration.Builder volumeConfiguration(Consumer<VolumeConfiguration.Builder> volumeConfiguration) Custom volume configuration for the root volumes that are attached to streaming sessions.
This parameter is only allowed when
This is a convenience method that creates an instance of thesessionPersistenceMode
isACTIVATED
.VolumeConfiguration.Builder
avoiding the need to create one manually viaVolumeConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovolumeConfiguration(VolumeConfiguration)
.- Parameters:
volumeConfiguration
- a consumer that will call methods onVolumeConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-