AWS::NimbleStudio::LaunchProfile StreamConfiguration

A configuration for a streaming session.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "AutomaticTerminationMode" : String,
  "ClipboardMode" : String,
  "Ec2InstanceTypes" : [ String, ... ],
  "MaxSessionLengthInMinutes" : Number,
  "MaxStoppedSessionLengthInMinutes" : Number,
  "SessionBackup" : StreamConfigurationSessionBackup,
  "SessionPersistenceMode" : String,
  "SessionStorage" : StreamConfigurationSessionStorage,
  "StreamingImageIds" : [ String, ... ],
  "VolumeConfiguration" : VolumeConfiguration
}

YAML

  AutomaticTerminationMode: String
  ClipboardMode: String
  Ec2InstanceTypes: 
    - String
  MaxSessionLengthInMinutes: Number
  MaxStoppedSessionLengthInMinutes: Number
  SessionBackup: 
    StreamConfigurationSessionBackup
  SessionPersistenceMode: String
  SessionStorage: 
    StreamConfigurationSessionStorage
  StreamingImageIds: 
    - String
  VolumeConfiguration: 
    VolumeConfiguration

Properties

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.

Required: No

Type: String

Allowed values: ACTIVATED | DEACTIVATED

Update requires: No interruption

ClipboardMode

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

Required: Yes

Type: String

Allowed values: DISABLED | ENABLED

Update requires: No interruption

Ec2InstanceTypes

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

Required: Yes

Type: Array of String

Minimum: 1

Maximum: 30

Update requires: No interruption

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.

Required: No

Type: Number

Minimum: 1

Maximum: 43200

Update requires: No interruption

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

Required: No

Type: Number

Minimum: 0

Maximum: 5760

Update requires: No interruption

SessionBackup

Information about the streaming session backup.

Required: No

Type: StreamConfigurationSessionBackup

Update requires: No interruption

SessionPersistenceMode

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

Required: No

Type: String

Allowed values: ACTIVATED | DEACTIVATED

Update requires: No interruption

SessionStorage

The upload storage for a streaming session.

Required: No

Type: StreamConfigurationSessionStorage

Update requires: No interruption

StreamingImageIds

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

Required: Yes

Type: Array of String

Minimum: 0 | 1

Maximum: 20 | 22

Update requires: No interruption

VolumeConfiguration

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

This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

Required: No

Type: VolumeConfiguration

Update requires: No interruption