#[non_exhaustive]pub struct StreamConfigurationCreateBuilder { /* private fields */ }
Expand description
A builder for StreamConfigurationCreate
.
Implementations§
Source§impl StreamConfigurationCreateBuilder
impl StreamConfigurationCreateBuilder
Sourcepub fn clipboard_mode(self, input: StreamingClipboardMode) -> Self
pub fn clipboard_mode(self, input: StreamingClipboardMode) -> Self
Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
This field is required.Sourcepub fn set_clipboard_mode(self, input: Option<StreamingClipboardMode>) -> Self
pub fn set_clipboard_mode(self, input: Option<StreamingClipboardMode>) -> Self
Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
Sourcepub fn get_clipboard_mode(&self) -> &Option<StreamingClipboardMode>
pub fn get_clipboard_mode(&self) -> &Option<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, input: StreamingInstanceType) -> Self
pub fn ec2_instance_types(self, input: StreamingInstanceType) -> Self
Appends an item to ec2_instance_types
.
To override the contents of this collection use set_ec2_instance_types
.
The EC2 instance types that users can select from when launching a streaming session with this launch profile.
Sourcepub fn set_ec2_instance_types(
self,
input: Option<Vec<StreamingInstanceType>>,
) -> Self
pub fn set_ec2_instance_types( self, input: Option<Vec<StreamingInstanceType>>, ) -> Self
The EC2 instance types that users can select from when launching a streaming session with this launch profile.
Sourcepub fn get_ec2_instance_types(&self) -> &Option<Vec<StreamingInstanceType>>
pub fn get_ec2_instance_types(&self) -> &Option<Vec<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, input: i32) -> Self
pub fn max_session_length_in_minutes(self, input: i32) -> Self
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 set_max_session_length_in_minutes(self, input: Option<i32>) -> Self
pub fn set_max_session_length_in_minutes(self, input: Option<i32>) -> Self
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 get_max_session_length_in_minutes(&self) -> &Option<i32>
pub fn get_max_session_length_in_minutes(&self) -> &Option<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, input: impl Into<String>) -> Self
pub fn streaming_image_ids(self, input: impl Into<String>) -> Self
Appends an item to streaming_image_ids
.
To override the contents of this collection use set_streaming_image_ids
.
The streaming images that users can select from when launching a streaming session with this launch profile.
Sourcepub fn set_streaming_image_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_streaming_image_ids(self, input: Option<Vec<String>>) -> Self
The streaming images that users can select from when launching a streaming session with this launch profile.
Sourcepub fn get_streaming_image_ids(&self) -> &Option<Vec<String>>
pub fn get_streaming_image_ids(&self) -> &Option<Vec<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, input: i32) -> Self
pub fn max_stopped_session_length_in_minutes(self, input: i32) -> Self
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 set_max_stopped_session_length_in_minutes(
self,
input: Option<i32>,
) -> Self
pub fn set_max_stopped_session_length_in_minutes( self, input: Option<i32>, ) -> Self
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 get_max_stopped_session_length_in_minutes(&self) -> &Option<i32>
pub fn get_max_stopped_session_length_in_minutes(&self) -> &Option<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, input: StreamConfigurationSessionStorage) -> Self
pub fn session_storage(self, input: StreamConfigurationSessionStorage) -> Self
The upload storage for a streaming workstation that is created using this launch profile.
Sourcepub fn set_session_storage(
self,
input: Option<StreamConfigurationSessionStorage>,
) -> Self
pub fn set_session_storage( self, input: Option<StreamConfigurationSessionStorage>, ) -> Self
The upload storage for a streaming workstation that is created using this launch profile.
Sourcepub fn get_session_storage(&self) -> &Option<StreamConfigurationSessionStorage>
pub fn get_session_storage(&self) -> &Option<StreamConfigurationSessionStorage>
The upload storage for a streaming workstation that is created using this launch profile.
Sourcepub fn session_backup(self, input: StreamConfigurationSessionBackup) -> Self
pub fn session_backup(self, input: StreamConfigurationSessionBackup) -> Self
Configures how streaming sessions are backed up when launched from this launch profile.
Sourcepub fn set_session_backup(
self,
input: Option<StreamConfigurationSessionBackup>,
) -> Self
pub fn set_session_backup( self, input: Option<StreamConfigurationSessionBackup>, ) -> Self
Configures how streaming sessions are backed up when launched from this launch profile.
Sourcepub fn get_session_backup(&self) -> &Option<StreamConfigurationSessionBackup>
pub fn get_session_backup(&self) -> &Option<StreamConfigurationSessionBackup>
Configures how streaming sessions are backed up when launched from this launch profile.
Sourcepub fn session_persistence_mode(self, input: SessionPersistenceMode) -> Self
pub fn session_persistence_mode(self, input: SessionPersistenceMode) -> Self
Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration
and automaticTerminationMode
are configured.
Sourcepub fn set_session_persistence_mode(
self,
input: Option<SessionPersistenceMode>,
) -> Self
pub fn set_session_persistence_mode( self, input: Option<SessionPersistenceMode>, ) -> Self
Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration
and automaticTerminationMode
are configured.
Sourcepub fn get_session_persistence_mode(&self) -> &Option<SessionPersistenceMode>
pub fn get_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, input: VolumeConfiguration) -> Self
pub fn volume_configuration(self, input: VolumeConfiguration) -> Self
Custom volume configuration for the root volumes that are attached to streaming sessions.
This parameter is only allowed when sessionPersistenceMode
is ACTIVATED
.
Sourcepub fn set_volume_configuration(
self,
input: Option<VolumeConfiguration>,
) -> Self
pub fn set_volume_configuration( self, input: Option<VolumeConfiguration>, ) -> Self
Custom volume configuration for the root volumes that are attached to streaming sessions.
This parameter is only allowed when sessionPersistenceMode
is ACTIVATED
.
Sourcepub fn get_volume_configuration(&self) -> &Option<VolumeConfiguration>
pub fn get_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, input: AutomaticTerminationMode) -> Self
pub fn automatic_termination_mode(self, input: AutomaticTerminationMode) -> Self
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 theSTOPPED
state for the time specified inmaxStoppedSessionLengthInMinutes
. -
When
DEACTIVATED
, the streaming session can remain in theSTOPPED
state indefinitely.
This parameter is only allowed when sessionPersistenceMode
is ACTIVATED
. When allowed, the default value for this parameter is DEACTIVATED
.
Sourcepub fn set_automatic_termination_mode(
self,
input: Option<AutomaticTerminationMode>,
) -> Self
pub fn set_automatic_termination_mode( self, input: Option<AutomaticTerminationMode>, ) -> Self
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 theSTOPPED
state for the time specified inmaxStoppedSessionLengthInMinutes
. -
When
DEACTIVATED
, the streaming session can remain in theSTOPPED
state indefinitely.
This parameter is only allowed when sessionPersistenceMode
is ACTIVATED
. When allowed, the default value for this parameter is DEACTIVATED
.
Sourcepub fn get_automatic_termination_mode(
&self,
) -> &Option<AutomaticTerminationMode>
pub fn get_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 theSTOPPED
state for the time specified inmaxStoppedSessionLengthInMinutes
. -
When
DEACTIVATED
, the streaming session can remain in theSTOPPED
state indefinitely.
This parameter is only allowed when sessionPersistenceMode
is ACTIVATED
. When allowed, the default value for this parameter is DEACTIVATED
.
Sourcepub fn build(self) -> Result<StreamConfigurationCreate, BuildError>
pub fn build(self) -> Result<StreamConfigurationCreate, BuildError>
Consumes the builder and constructs a StreamConfigurationCreate
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for StreamConfigurationCreateBuilder
impl Clone for StreamConfigurationCreateBuilder
Source§fn clone(&self) -> StreamConfigurationCreateBuilder
fn clone(&self) -> StreamConfigurationCreateBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for StreamConfigurationCreateBuilder
impl Default for StreamConfigurationCreateBuilder
Source§fn default() -> StreamConfigurationCreateBuilder
fn default() -> StreamConfigurationCreateBuilder
Source§impl PartialEq for StreamConfigurationCreateBuilder
impl PartialEq for StreamConfigurationCreateBuilder
Source§fn eq(&self, other: &StreamConfigurationCreateBuilder) -> bool
fn eq(&self, other: &StreamConfigurationCreateBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for StreamConfigurationCreateBuilder
Auto Trait Implementations§
impl Freeze for StreamConfigurationCreateBuilder
impl RefUnwindSafe for StreamConfigurationCreateBuilder
impl Send for StreamConfigurationCreateBuilder
impl Sync for StreamConfigurationCreateBuilder
impl Unpin for StreamConfigurationCreateBuilder
impl UnwindSafe for StreamConfigurationCreateBuilder
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);