#[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>,
}Expand description
A configuration for a streaming session.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.clipboard_mode: StreamingClipboardModeAllows 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: i32The 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: i32Integer 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 theSTOPPEDstate for the time specified inmaxStoppedSessionLengthInMinutes. -
When
DEACTIVATED, the streaming session can remain in theSTOPPEDstate indefinitely.
This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.
Implementations§
Source§impl StreamConfiguration
impl StreamConfiguration
Sourcepub fn clipboard_mode(&self) -> &StreamingClipboardMode
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.
Sourcepub fn ec2_instance_types(&self) -> &[StreamingInstanceType]
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.
Sourcepub fn max_session_length_in_minutes(&self) -> i32
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.
Sourcepub fn streaming_image_ids(&self) -> &[String]
pub fn streaming_image_ids(&self) -> &[String]
The streaming images that users can select from when launching a streaming session with this launch profile.
Sourcepub fn max_stopped_session_length_in_minutes(&self) -> i32
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).
Sourcepub fn session_storage(&self) -> Option<&StreamConfigurationSessionStorage>
pub fn session_storage(&self) -> Option<&StreamConfigurationSessionStorage>
The upload storage for a streaming session.
Sourcepub fn session_backup(&self) -> Option<&StreamConfigurationSessionBackup>
pub fn session_backup(&self) -> Option<&StreamConfigurationSessionBackup>
Information about the streaming session backup.
Sourcepub fn session_persistence_mode(&self) -> Option<&SessionPersistenceMode>
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.
Sourcepub fn volume_configuration(&self) -> Option<&VolumeConfiguration>
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.
Sourcepub fn automatic_termination_mode(&self) -> Option<&AutomaticTerminationMode>
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 theSTOPPEDstate for the time specified inmaxStoppedSessionLengthInMinutes. -
When
DEACTIVATED, the streaming session can remain in theSTOPPEDstate indefinitely.
This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.
Source§impl StreamConfiguration
impl StreamConfiguration
Sourcepub fn builder() -> StreamConfigurationBuilder
pub fn builder() -> StreamConfigurationBuilder
Creates a new builder-style object to manufacture StreamConfiguration.
Trait Implementations§
Source§impl Clone for StreamConfiguration
impl Clone for StreamConfiguration
Source§fn clone(&self) -> StreamConfiguration
fn clone(&self) -> StreamConfiguration
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for StreamConfiguration
impl Debug for StreamConfiguration
Source§impl PartialEq for StreamConfiguration
impl PartialEq for StreamConfiguration
impl StructuralPartialEq for StreamConfiguration
Auto Trait Implementations§
impl Freeze for StreamConfiguration
impl RefUnwindSafe for StreamConfiguration
impl Send for StreamConfiguration
impl Sync for StreamConfiguration
impl Unpin for StreamConfiguration
impl UnwindSafe for StreamConfiguration
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);