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" : Double,
  "MaxStoppedSessionLengthInMinutes" : Double,
  "SessionBackup" : StreamConfigurationSessionBackup,
  "SessionPersistenceMode" : String,
  "SessionStorage" : StreamConfigurationSessionStorage,
  "StreamingImageIds" : [ String, ... ],
  "VolumeConfiguration" : VolumeConfiguration
}

YAML

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

Properties

AutomaticTerminationMode

Property description not available.

Required: No

Type: String

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

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: List of String

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: Double

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: Double

Update requires: No interruption

SessionBackup

Property description not available.

Required: No

Type: StreamConfigurationSessionBackup

Update requires: No interruption

SessionPersistenceMode

Property description not available.

Required: No

Type: String

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: List of String

Update requires: No interruption

VolumeConfiguration

Property description not available.

Required: No

Type: VolumeConfiguration

Update requires: No interruption