nimble/aws.sdk.kotlin.services.nimble.model/StreamingSession/Builder

Builder

class Builder

Properties

Link copied to clipboard
var arn: String?

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

Link copied to clipboard
var 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.

Link copied to clipboard
var backupMode: SessionBackupMode?

Shows the current backup setting of the session.

Link copied to clipboard
var createdAt: Instant?

The ISO timestamp in seconds for when the resource was created.

Link copied to clipboard
var createdBy: String?

The user ID of the user that created the streaming session.

Link copied to clipboard
var ec2InstanceType: String?

The EC2 Instance type used for the streaming session.

Link copied to clipboard
var launchProfileId: String?

The ID of the launch profile used to control access from the streaming session.

Link copied to clipboard
var maxBackupsToRetain: Int

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.

Link copied to clipboard
var ownedBy: String?

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.

Link copied to clipboard
var sessionId: String?

The session ID.

Link copied to clipboard
var sessionPersistenceMode: SessionPersistenceMode?

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

Link copied to clipboard
var startedAt: Instant?

The time the session entered START_IN_PROGRESS state.

Link copied to clipboard
var startedBy: String?

The user ID of the user that started the streaming session.

Link copied to clipboard
var startedFromBackupId: String?

The backup ID used to restore a streaming session.

Link copied to clipboard
var state: StreamingSessionState?

The current state.

Link copied to clipboard
var statusCode: StreamingSessionStatusCode?

The status code.

Link copied to clipboard
var statusMessage: String?

The status message for the streaming session.

Link copied to clipboard
var stopAt: Instant?

The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.

Link copied to clipboard
var stoppedAt: Instant?

The time the session entered STOP_IN_PROGRESS state.

Link copied to clipboard
var stoppedBy: String?

The user ID of the user that stopped the streaming session.

Link copied to clipboard
var streamingImageId: String?

The ID of the streaming image.

Link copied to clipboard
var tags: Map<String, String>?

A collection of labels, in the form of key-value pairs, that apply to this resource.

Link copied to clipboard
var terminateAt: Instant?

The time the streaming session will automatically terminate if not terminated by the user.

Link copied to clipboard
var updatedAt: Instant?

The ISO timestamp in seconds for when the resource was updated.

Link copied to clipboard
var updatedBy: String?

The user ID of the user that most recently updated the resource.

Link copied to clipboard
var volumeConfiguration: VolumeConfiguration?

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

Link copied to clipboard
var volumeRetentionMode: VolumeRetentionMode?

Determine if an EBS volume created from this streaming session will be backed up.

Functions

Link copied to clipboard