Struct aws_sdk_nimble::types::builders::StreamConfigurationCreateBuilder

#[non_exhaustive]
pub struct StreamConfigurationCreateBuilder { /* private fields */ }

A builder for StreamConfigurationCreate.

Implementations

impl StreamConfigurationCreateBuilder

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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

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

pub fn session_storage(self, input: StreamConfigurationSessionStorage) -> Self

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

pub fn set_session_storage( self, input: Option<StreamConfigurationSessionStorage> ) -> Self

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

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

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

pub fn session_backup(self, input: StreamConfigurationSessionBackup) -> Self

Configures how streaming sessions are backed up when launched from this launch profile.

pub fn set_session_backup( self, input: Option<StreamConfigurationSessionBackup> ) -> Self

Configures how streaming sessions are backed up when launched from this launch profile.

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

Configures how streaming sessions are backed up when launched from this launch profile.

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.

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.

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.

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.

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.

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.

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

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

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

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:

• clipboard_mode
• ec2_instance_types
• streaming_image_ids

Trait Implementations

impl Clone for StreamConfigurationCreateBuilder

fn clone(&self) -> StreamConfigurationCreateBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StreamConfigurationCreateBuilder

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

Formats the value using the given formatter.

impl Default for StreamConfigurationCreateBuilder

fn default() -> StreamConfigurationCreateBuilder

Returns the “default value” for a type.

impl PartialEq for StreamConfigurationCreateBuilder

fn eq(&self, other: &StreamConfigurationCreateBuilder) -> 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 StreamConfigurationCreateBuilder