Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StreamConfigurationCreate

Configuration for streaming workstations created using this launch profile.

Hierarchy

  • StreamConfigurationCreate

Index

Properties

Optional automaticTerminationMode

automaticTerminationMode: AutomaticTerminationMode | string

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.

clipboardMode

clipboardMode: StreamingClipboardMode | string | undefined

Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.

ec2InstanceTypes

ec2InstanceTypes: (StreamingInstanceType | string)[] | undefined

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

Optional maxSessionLengthInMinutes

maxSessionLengthInMinutes: undefined | number

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.

Optional maxStoppedSessionLengthInMinutes

maxStoppedSessionLengthInMinutes: undefined | number

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 is ACTIVATED and automaticTerminationMode is ACTIVATED.

If the value is 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 (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 (instead of terminated).

Optional sessionBackup

Configures how streaming sessions are backed up when launched from this launch profile.

Optional sessionPersistenceMode

sessionPersistenceMode: SessionPersistenceMode | string

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

Optional sessionStorage

The upload storage for a streaming workstation that is created using this launch profile.

streamingImageIds

streamingImageIds: string[] | undefined

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

Optional 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.