Class: Aws::NimbleStudio::Types::StreamConfigurationCreate

Inherits:

Struct

• Object
• Struct
• Aws::NimbleStudio::Types::StreamConfigurationCreate

Defined in:

gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb

Overview

Note:

When making an API call, you may pass StreamConfigurationCreate data as a hash:

{
  clipboard_mode: "ENABLED", # required, accepts ENABLED, DISABLED
  ec2_instance_types: ["g4dn.xlarge"], # required, accepts g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge
  max_session_length_in_minutes: 1,
  max_stopped_session_length_in_minutes: 1,
  session_storage: {
    mode: ["UPLOAD"], # required, accepts UPLOAD
    root: {
      linux: "StreamingSessionStorageRootPathLinux",
      windows: "StreamingSessionStorageRootPathWindows",
    },
  },
  streaming_image_ids: ["StreamingImageId"], # required
}

Configuration for streaming workstations created using this launch profile.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #clipboard_mode ⇒ String

  Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.

• #ec2_instance_types ⇒ Array<String>

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

• #max_session_length_in_minutes ⇒ Integer

  The length of time, in minutes, that a streaming session can be active before it is stopped or terminated.

• #max_stopped_session_length_in_minutes ⇒ Integer

  Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state.

• #session_storage ⇒ Types::StreamConfigurationSessionStorage

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

• #streaming_image_ids ⇒ Array<String>

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

Instance Attribute Details

#clipboard_mode ⇒ String

Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.

Returns:

• (String)

# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 2973

class StreamConfigurationCreate < Struct.new(
  :clipboard_mode,
  :ec2_instance_types,
  :max_session_length_in_minutes,
  :max_stopped_session_length_in_minutes,
  :session_storage,
  :streaming_image_ids)
  SENSITIVE = []
  include Aws::Structure
end

#ec2_instance_types ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 2973

class StreamConfigurationCreate < Struct.new(
  :clipboard_mode,
  :ec2_instance_types,
  :max_session_length_in_minutes,
  :max_stopped_session_length_in_minutes,
  :session_storage,
  :streaming_image_ids)
  SENSITIVE = []
  include Aws::Structure
end

#max_session_length_in_minutes ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 2973

class StreamConfigurationCreate < Struct.new(
  :clipboard_mode,
  :ec2_instance_types,
  :max_session_length_in_minutes,
  :max_stopped_session_length_in_minutes,
  :session_storage,
  :streaming_image_ids)
  SENSITIVE = []
  include Aws::Structure
end

#max_stopped_session_length_in_minutes ⇒ Integer

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.

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

Returns:

• (Integer)

# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 2973

class StreamConfigurationCreate < Struct.new(
  :clipboard_mode,
  :ec2_instance_types,
  :max_session_length_in_minutes,
  :max_stopped_session_length_in_minutes,
  :session_storage,
  :streaming_image_ids)
  SENSITIVE = []
  include Aws::Structure
end

#session_storage ⇒ Types::StreamConfigurationSessionStorage

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

Returns:

• (Types::StreamConfigurationSessionStorage)

# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 2973

class StreamConfigurationCreate < Struct.new(
  :clipboard_mode,
  :ec2_instance_types,
  :max_session_length_in_minutes,
  :max_stopped_session_length_in_minutes,
  :session_storage,
  :streaming_image_ids)
  SENSITIVE = []
  include Aws::Structure
end

#streaming_image_ids ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 2973

class StreamConfigurationCreate < Struct.new(
  :clipboard_mode,
  :ec2_instance_types,
  :max_session_length_in_minutes,
  :max_stopped_session_length_in_minutes,
  :session_storage,
  :streaming_image_ids)
  SENSITIVE = []
  include Aws::Structure
end