Struct aws_sdk_nimble::types::StreamConfiguration

#[non_exhaustive]
pub struct StreamConfiguration {
    pub clipboard_mode: StreamingClipboardMode,
    pub ec2_instance_types: Vec<StreamingInstanceType>,
    pub max_session_length_in_minutes: i32,
    pub streaming_image_ids: Vec<String>,
    pub max_stopped_session_length_in_minutes: i32,
    pub session_storage: Option<StreamConfigurationSessionStorage>,
    pub session_backup: Option<StreamConfigurationSessionBackup>,
    pub session_persistence_mode: Option<SessionPersistenceMode>,
    pub volume_configuration: Option<VolumeConfiguration>,
    pub automatic_termination_mode: Option<AutomaticTerminationMode>,
}

A configuration for a streaming session.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

clipboard_mode: StreamingClipboardMode

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

ec2_instance_types: Vec<StreamingInstanceType>

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

max_session_length_in_minutes: i32

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.

streaming_image_ids: Vec<String>

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

max_stopped_session_length_in_minutes: i32

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

session_storage: Option<StreamConfigurationSessionStorage>

The upload storage for a streaming session.

session_backup: Option<StreamConfigurationSessionBackup>

Information about the streaming session backup.

session_persistence_mode: Option<SessionPersistenceMode>

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

volume_configuration: Option<VolumeConfiguration>

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

This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

automatic_termination_mode: Option<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.

Implementations

impl StreamConfiguration

pub fn clipboard_mode(&self) -> &StreamingClipboardMode

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

pub fn ec2_instance_types(&self) -> &[StreamingInstanceType]

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

pub fn max_session_length_in_minutes(&self) -> i32

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.

pub fn streaming_image_ids(&self) -> &[String]

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

pub fn max_stopped_session_length_in_minutes(&self) -> i32

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

pub fn session_storage(&self) -> Option<&StreamConfigurationSessionStorage>

The upload storage for a streaming session.

pub fn session_backup(&self) -> Option<&StreamConfigurationSessionBackup>

Information about the streaming session backup.

pub fn session_persistence_mode(&self) -> Option<&SessionPersistenceMode>

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

pub fn volume_configuration(&self) -> Option<&VolumeConfiguration>

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

This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

pub fn automatic_termination_mode(&self) -> Option<&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.

impl StreamConfiguration

pub fn builder() -> StreamConfigurationBuilder

Creates a new builder-style object to manufacture StreamConfiguration.

Trait Implementations

impl Clone for StreamConfiguration

fn clone(&self) -> StreamConfiguration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StreamConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for StreamConfiguration

fn eq(&self, other: &StreamConfiguration) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StreamConfiguration