StreamConfiguration - Amazon Nimble Studio

StreamConfiguration

A configuration for a streaming session.

Contents

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.

Type: String

Valid Values: DEACTIVATED | ACTIVATED

Required: No

clipboardMode

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

Type: String

Valid Values: ENABLED | DISABLED

Required: Yes

ec2InstanceTypes

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 30 items.

Valid Values: g4dn.xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.12xlarge | g4dn.16xlarge | g3.4xlarge | g3s.xlarge | g5.xlarge | g5.2xlarge | g5.4xlarge | g5.8xlarge | g5.16xlarge

Required: Yes

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 43200.

Required: No

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

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 5760.

Required: No

sessionBackup

Information about the streaming session backup.

Type: StreamConfigurationSessionBackup object

Required: No

sessionPersistenceMode

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

Type: String

Valid Values: DEACTIVATED | ACTIVATED

Required: No

sessionStorage

The upload storage for a streaming session.

Type: StreamConfigurationSessionStorage object

Required: No

streamingImageIds

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 20 items.

Length Constraints: Minimum length of 0. Maximum length of 22.

Pattern: ^[a-zA-Z0-9-_]*$

Required: Yes

volumeConfiguration

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

This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

Type: VolumeConfiguration object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: