software.amazon.awssdk.services.nimble.model

Interface StreamingSession.Builder

All Superinterfaces:

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

Enclosing class:

StreamingSession

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

Method Summary

Modifier and Type	Method and Description
StreamingSession.Builder	arn(String arn) The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it.
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.
StreamingSession.Builder	automaticTerminationMode(String 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.
StreamingSession.Builder	backupMode(SessionBackupMode backupMode) Shows the current backup setting of the session.
StreamingSession.Builder	backupMode(String backupMode) Shows the current backup setting of the session.
StreamingSession.Builder	createdAt(Instant createdAt) The ISO timestamp in seconds for when the resource was created.
StreamingSession.Builder	createdBy(String createdBy) The user ID of the user that created the streaming session.
StreamingSession.Builder	ec2InstanceType(String ec2InstanceType) The EC2 Instance type used for the streaming session.
StreamingSession.Builder	launchProfileId(String launchProfileId) The ID of the launch profile used to control access from the streaming session.
StreamingSession.Builder	maxBackupsToRetain(Integer maxBackupsToRetain) The maximum number of backups of a streaming session that you can have.
StreamingSession.Builder	ownedBy(String ownedBy) The user ID of the user that owns the streaming session.
StreamingSession.Builder	sessionId(String sessionId) The session ID.
StreamingSession.Builder	sessionPersistenceMode(SessionPersistenceMode sessionPersistenceMode) Determine if a streaming session created from this launch profile can configure persistent storage.
StreamingSession.Builder	sessionPersistenceMode(String sessionPersistenceMode) Determine if a streaming session created from this launch profile can configure persistent storage.
StreamingSession.Builder	startedAt(Instant startedAt) The time the session entered START_IN_PROGRESS state.
StreamingSession.Builder	startedBy(String startedBy) The user ID of the user that started the streaming session.
StreamingSession.Builder	startedFromBackupId(String startedFromBackupId) The backup ID used to restore a streaming session.
StreamingSession.Builder	state(StreamingSessionState state) The current state.
StreamingSession.Builder	state(String state) The current state.
StreamingSession.Builder	statusCode(StreamingSessionStatusCode statusCodeValue) The status code.
StreamingSession.Builder	statusCode(String statusCodeValue) The status code.
StreamingSession.Builder	statusMessage(String statusMessage) The status message for the streaming session.
StreamingSession.Builder	stopAt(Instant stopAt) The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.
StreamingSession.Builder	stoppedAt(Instant stoppedAt) The time the session entered STOP_IN_PROGRESS state.
StreamingSession.Builder	stoppedBy(String stoppedBy) The user ID of the user that stopped the streaming session.
StreamingSession.Builder	streamingImageId(String streamingImageId) The ID of the streaming image.
StreamingSession.Builder	tags(Map<String,String> tags) A collection of labels, in the form of key-value pairs, that apply to this resource.
StreamingSession.Builder	terminateAt(Instant terminateAt) The time the streaming session will automatically terminate if not terminated by the user.
StreamingSession.Builder	updatedAt(Instant updatedAt) The ISO timestamp in seconds for when the resource was updated.
StreamingSession.Builder	updatedBy(String updatedBy) 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.
StreamingSession.Builder	volumeConfiguration(VolumeConfiguration volumeConfiguration) Custom volume configuration for the root volumes that are attached to streaming sessions.
StreamingSession.Builder	volumeRetentionMode(String volumeRetentionMode) Determine if an EBS volume created from this streaming session will be backed up.
StreamingSession.Builder	volumeRetentionMode(VolumeRetentionMode volumeRetentionMode) Determine if an EBS volume created from this streaming session will be backed up.

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

arn

StreamingSession.Builder arn(String 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

StreamingSession.Builder automaticTerminationMode(String 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 the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.

• When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

Parameters:

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 the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.

• When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

Returns:

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

See Also:

AutomaticTerminationMode, AutomaticTerminationMode

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 the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.

• When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

Parameters:

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 the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.

• When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

Returns:

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

See Also:

AutomaticTerminationMode, AutomaticTerminationMode

backupMode

StreamingSession.Builder backupMode(String 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:

SessionBackupMode, SessionBackupMode

backupMode

StreamingSession.Builder backupMode(SessionBackupMode 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:

SessionBackupMode, SessionBackupMode

createdAt

StreamingSession.Builder createdAt(Instant 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

StreamingSession.Builder createdBy(String 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

StreamingSession.Builder ec2InstanceType(String 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

StreamingSession.Builder launchProfileId(String 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

StreamingSession.Builder maxBackupsToRetain(Integer 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

StreamingSession.Builder ownedBy(String 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

StreamingSession.Builder sessionId(String 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

StreamingSession.Builder sessionPersistenceMode(String sessionPersistenceMode)

Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

Parameters:

sessionPersistenceMode - Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

Returns:

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

See Also:

SessionPersistenceMode, SessionPersistenceMode

sessionPersistenceMode

StreamingSession.Builder sessionPersistenceMode(SessionPersistenceMode sessionPersistenceMode)

Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

Parameters:

sessionPersistenceMode - Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

Returns:

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

See Also:

SessionPersistenceMode, SessionPersistenceMode

startedAt

StreamingSession.Builder startedAt(Instant startedAt)

The time the session entered START_IN_PROGRESS state.

Parameters:

startedAt - The time the session entered START_IN_PROGRESS state.

Returns:

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

startedBy

StreamingSession.Builder startedBy(String 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

StreamingSession.Builder startedFromBackupId(String 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

StreamingSession.Builder state(String 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:

StreamingSessionState, StreamingSessionState

state

StreamingSession.Builder state(StreamingSessionState 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:

StreamingSessionState, StreamingSessionState

statusCode

StreamingSession.Builder statusCode(String statusCodeValue)

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:

StreamingSessionStatusCode, StreamingSessionStatusCode

statusCode

StreamingSession.Builder statusCode(StreamingSessionStatusCode statusCodeValue)

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:

StreamingSessionStatusCode, StreamingSessionStatusCode

statusMessage

StreamingSession.Builder statusMessage(String 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

StreamingSession.Builder stopAt(Instant 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

StreamingSession.Builder stoppedAt(Instant stoppedAt)

The time the session entered STOP_IN_PROGRESS state.

Parameters:

stoppedAt - The time the session entered STOP_IN_PROGRESS state.

Returns:

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

stoppedBy

StreamingSession.Builder stoppedBy(String 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

StreamingSession.Builder streamingImageId(String 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

StreamingSession.Builder tags(Map<String,String> 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

StreamingSession.Builder terminateAt(Instant 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

StreamingSession.Builder updatedAt(Instant 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

StreamingSession.Builder updatedBy(String 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

StreamingSession.Builder volumeConfiguration(VolumeConfiguration volumeConfiguration)

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

Parameters:

volumeConfiguration - Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

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 sessionPersistenceMode is ACTIVATED.

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

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

Parameters:

volumeConfiguration - a consumer that will call methods on VolumeConfiguration.Builder

Returns:

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

See Also:

volumeConfiguration(VolumeConfiguration)

volumeRetentionMode

StreamingSession.Builder volumeRetentionMode(String 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, VolumeRetentionMode

volumeRetentionMode

StreamingSession.Builder volumeRetentionMode(VolumeRetentionMode 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, VolumeRetentionMode