Interface StreamingSession.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<StreamingSession.Builder,
,StreamingSession> SdkBuilder<StreamingSession.Builder,
,StreamingSession> SdkPojo
- Enclosing class:
StreamingSession
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it.automaticTerminationMode
(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.backupMode
(String backupMode) Shows the current backup setting of the session.backupMode
(SessionBackupMode backupMode) Shows the current backup setting of the session.The ISO timestamp in seconds for when the resource was created.The user ID of the user that created the streaming session.ec2InstanceType
(String ec2InstanceType) The EC2 Instance type used for the streaming session.launchProfileId
(String launchProfileId) The ID of the launch profile used to control access from the streaming session.maxBackupsToRetain
(Integer maxBackupsToRetain) The maximum number of backups of a streaming session that you can have.The user ID of the user that owns the streaming session.The session ID.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.The time the session enteredSTART_IN_PROGRESS
state.The user ID of the user that started the streaming session.startedFromBackupId
(String startedFromBackupId) The backup ID used to restore a streaming session.The current state.state
(StreamingSessionState state) The current state.statusCode
(String statusCodeValue) The status code.statusCode
(StreamingSessionStatusCode statusCodeValue) The status code.statusMessage
(String statusMessage) The status message for the streaming session.The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.The time the session enteredSTOP_IN_PROGRESS
state.The user ID of the user that stopped the streaming session.streamingImageId
(String streamingImageId) The ID of the streaming image.A collection of labels, in the form of key-value pairs, that apply to this resource.terminateAt
(Instant terminateAt) The time the streaming session will automatically terminate if not terminated by the user.The ISO timestamp in seconds for when the resource was updated.The user ID of the user that most recently updated the resource.default StreamingSession.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.volumeRetentionMode
(String volumeRetentionMode) Determine if an EBS volume created from this streaming session will be backed up.volumeRetentionMode
(VolumeRetentionMode volumeRetentionMode) Determine if an EBS volume created from this streaming session will be backed up.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
-
arn
The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
- Parameters:
arn
- The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
StreamingSession.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:
-
-
backupMode
Shows the current backup setting of the session.
- Parameters:
backupMode
- Shows the current backup setting of the session.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
backupMode
Shows the current backup setting of the session.
- Parameters:
backupMode
- Shows the current backup setting of the session.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
createdAt
The ISO timestamp in seconds for when the resource was created.
- Parameters:
createdAt
- The ISO timestamp in seconds for when the resource was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
createdBy
The user ID of the user that created the streaming session.
- Parameters:
createdBy
- The user ID of the user that created the streaming session.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ec2InstanceType
The EC2 Instance type used for the streaming session.
- Parameters:
ec2InstanceType
- The EC2 Instance type used for the streaming session.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
launchProfileId
The ID of the launch profile used to control access from the streaming session.
- Parameters:
launchProfileId
- The ID of the launch profile used to control access from the streaming session.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxBackupsToRetain
The maximum number of backups of a streaming session that you can have. When the maximum number of backups is reached, the oldest backup is deleted.
- Parameters:
maxBackupsToRetain
- The maximum number of backups of a streaming session that you can have. When the maximum number of backups is reached, the oldest backup is deleted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ownedBy
The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.
- Parameters:
ownedBy
- The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sessionId
The session ID.
- Parameters:
sessionId
- The session ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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:
-
startedAt
The time the session entered
START_IN_PROGRESS
state.- Parameters:
startedAt
- The time the session enteredSTART_IN_PROGRESS
state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startedBy
The user ID of the user that started the streaming session.
- Parameters:
startedBy
- The user ID of the user that started the streaming session.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startedFromBackupId
The backup ID used to restore a streaming session.
- Parameters:
startedFromBackupId
- The backup ID used to restore a streaming session.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
state
The current state.
- Parameters:
state
- The current state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
state
The current state.
- Parameters:
state
- The current state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
statusCode
The status code.
- Parameters:
statusCodeValue
- The status code.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
statusCode
The status code.
- Parameters:
statusCodeValue
- The status code.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
statusMessage
The status message for the streaming session.
- Parameters:
statusMessage
- The status message for the streaming session.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stopAt
The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.
- Parameters:
stopAt
- The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stoppedAt
The time the session entered
STOP_IN_PROGRESS
state.- Parameters:
stoppedAt
- The time the session enteredSTOP_IN_PROGRESS
state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stoppedBy
The user ID of the user that stopped the streaming session.
- Parameters:
stoppedBy
- The user ID of the user that stopped the streaming session.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
streamingImageId
The ID of the streaming image.
- Parameters:
streamingImageId
- The ID of the streaming image.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A collection of labels, in the form of key-value pairs, that apply to this resource.
- Parameters:
tags
- A collection of labels, in the form of key-value pairs, that apply to this resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
terminateAt
The time the streaming session will automatically terminate if not terminated by the user.
- Parameters:
terminateAt
- The time the streaming session will automatically terminate if not terminated by the user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
updatedAt
The ISO timestamp in seconds for when the resource was updated.
- Parameters:
updatedAt
- The ISO timestamp in seconds for when the resource was updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
updatedBy
The user ID of the user that most recently updated the resource.
- Parameters:
updatedBy
- The user ID of the user that most recently updated the resource.- 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 StreamingSession.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:
-
volumeRetentionMode
Determine if an EBS volume created from this streaming session will be backed up.
- Parameters:
volumeRetentionMode
- Determine if an EBS volume created from this streaming session will be backed up.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
volumeRetentionMode
Determine if an EBS volume created from this streaming session will be backed up.
- Parameters:
volumeRetentionMode
- Determine if an EBS volume created from this streaming session will be backed up.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-