Struct aws_sdk_nimble::types::builders::StreamingSessionBuilder
source · #[non_exhaustive]pub struct StreamingSessionBuilder { /* private fields */ }Expand description
A builder for StreamingSession.
Implementations§
source§impl StreamingSessionBuilder
impl StreamingSessionBuilder
sourcepub fn arn(self, input: impl Into<String>) -> Self
pub fn arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
sourcepub fn set_arn(self, input: Option<String>) -> Self
pub fn set_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
sourcepub fn get_arn(&self) -> &Option<String>
pub fn get_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
sourcepub fn created_at(self, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
The ISO timestamp in seconds for when the resource was created.
sourcepub fn set_created_at(self, input: Option<DateTime>) -> Self
pub fn set_created_at(self, input: Option<DateTime>) -> Self
The ISO timestamp in seconds for when the resource was created.
sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
The ISO timestamp in seconds for when the resource was created.
sourcepub fn created_by(self, input: impl Into<String>) -> Self
pub fn created_by(self, input: impl Into<String>) -> Self
The user ID of the user that created the streaming session.
sourcepub fn set_created_by(self, input: Option<String>) -> Self
pub fn set_created_by(self, input: Option<String>) -> Self
The user ID of the user that created the streaming session.
sourcepub fn get_created_by(&self) -> &Option<String>
pub fn get_created_by(&self) -> &Option<String>
The user ID of the user that created the streaming session.
sourcepub fn ec2_instance_type(self, input: impl Into<String>) -> Self
pub fn ec2_instance_type(self, input: impl Into<String>) -> Self
The EC2 Instance type used for the streaming session.
sourcepub fn set_ec2_instance_type(self, input: Option<String>) -> Self
pub fn set_ec2_instance_type(self, input: Option<String>) -> Self
The EC2 Instance type used for the streaming session.
sourcepub fn get_ec2_instance_type(&self) -> &Option<String>
pub fn get_ec2_instance_type(&self) -> &Option<String>
The EC2 Instance type used for the streaming session.
sourcepub fn launch_profile_id(self, input: impl Into<String>) -> Self
pub fn launch_profile_id(self, input: impl Into<String>) -> Self
The ID of the launch profile used to control access from the streaming session.
sourcepub fn set_launch_profile_id(self, input: Option<String>) -> Self
pub fn set_launch_profile_id(self, input: Option<String>) -> Self
The ID of the launch profile used to control access from the streaming session.
sourcepub fn get_launch_profile_id(&self) -> &Option<String>
pub fn get_launch_profile_id(&self) -> &Option<String>
The ID of the launch profile used to control access from the streaming session.
sourcepub fn owned_by(self, input: impl Into<String>) -> Self
pub fn owned_by(self, input: impl Into<String>) -> Self
The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.
sourcepub fn set_owned_by(self, input: Option<String>) -> Self
pub fn set_owned_by(self, input: Option<String>) -> Self
The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.
sourcepub fn get_owned_by(&self) -> &Option<String>
pub fn get_owned_by(&self) -> &Option<String>
The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.
sourcepub fn session_id(self, input: impl Into<String>) -> Self
pub fn session_id(self, input: impl Into<String>) -> Self
The session ID.
sourcepub fn set_session_id(self, input: Option<String>) -> Self
pub fn set_session_id(self, input: Option<String>) -> Self
The session ID.
sourcepub fn get_session_id(&self) -> &Option<String>
pub fn get_session_id(&self) -> &Option<String>
The session ID.
sourcepub fn state(self, input: StreamingSessionState) -> Self
pub fn state(self, input: StreamingSessionState) -> Self
The current state.
sourcepub fn set_state(self, input: Option<StreamingSessionState>) -> Self
pub fn set_state(self, input: Option<StreamingSessionState>) -> Self
The current state.
sourcepub fn get_state(&self) -> &Option<StreamingSessionState>
pub fn get_state(&self) -> &Option<StreamingSessionState>
The current state.
sourcepub fn status_code(self, input: StreamingSessionStatusCode) -> Self
pub fn status_code(self, input: StreamingSessionStatusCode) -> Self
The status code.
sourcepub fn set_status_code(self, input: Option<StreamingSessionStatusCode>) -> Self
pub fn set_status_code(self, input: Option<StreamingSessionStatusCode>) -> Self
The status code.
sourcepub fn get_status_code(&self) -> &Option<StreamingSessionStatusCode>
pub fn get_status_code(&self) -> &Option<StreamingSessionStatusCode>
The status code.
sourcepub fn status_message(self, input: impl Into<String>) -> Self
pub fn status_message(self, input: impl Into<String>) -> Self
The status message for the streaming session.
sourcepub fn set_status_message(self, input: Option<String>) -> Self
pub fn set_status_message(self, input: Option<String>) -> Self
The status message for the streaming session.
sourcepub fn get_status_message(&self) -> &Option<String>
pub fn get_status_message(&self) -> &Option<String>
The status message for the streaming session.
sourcepub fn streaming_image_id(self, input: impl Into<String>) -> Self
pub fn streaming_image_id(self, input: impl Into<String>) -> Self
The ID of the streaming image.
sourcepub fn set_streaming_image_id(self, input: Option<String>) -> Self
pub fn set_streaming_image_id(self, input: Option<String>) -> Self
The ID of the streaming image.
sourcepub fn get_streaming_image_id(&self) -> &Option<String>
pub fn get_streaming_image_id(&self) -> &Option<String>
The ID of the streaming image.
Adds a key-value pair to tags.
To override the contents of this collection use set_tags.
A collection of labels, in the form of key-value pairs, that apply to this resource.
A collection of labels, in the form of key-value pairs, that apply to this resource.
A collection of labels, in the form of key-value pairs, that apply to this resource.
sourcepub fn terminate_at(self, input: DateTime) -> Self
pub fn terminate_at(self, input: DateTime) -> Self
The time the streaming session will automatically terminate if not terminated by the user.
sourcepub fn set_terminate_at(self, input: Option<DateTime>) -> Self
pub fn set_terminate_at(self, input: Option<DateTime>) -> Self
The time the streaming session will automatically terminate if not terminated by the user.
sourcepub fn get_terminate_at(&self) -> &Option<DateTime>
pub fn get_terminate_at(&self) -> &Option<DateTime>
The time the streaming session will automatically terminate if not terminated by the user.
sourcepub fn updated_at(self, input: DateTime) -> Self
pub fn updated_at(self, input: DateTime) -> Self
The ISO timestamp in seconds for when the resource was updated.
sourcepub fn set_updated_at(self, input: Option<DateTime>) -> Self
pub fn set_updated_at(self, input: Option<DateTime>) -> Self
The ISO timestamp in seconds for when the resource was updated.
sourcepub fn get_updated_at(&self) -> &Option<DateTime>
pub fn get_updated_at(&self) -> &Option<DateTime>
The ISO timestamp in seconds for when the resource was updated.
sourcepub fn updated_by(self, input: impl Into<String>) -> Self
pub fn updated_by(self, input: impl Into<String>) -> Self
The user ID of the user that most recently updated the resource.
sourcepub fn set_updated_by(self, input: Option<String>) -> Self
pub fn set_updated_by(self, input: Option<String>) -> Self
The user ID of the user that most recently updated the resource.
sourcepub fn get_updated_by(&self) -> &Option<String>
pub fn get_updated_by(&self) -> &Option<String>
The user ID of the user that most recently updated the resource.
sourcepub fn stopped_at(self, input: DateTime) -> Self
pub fn stopped_at(self, input: DateTime) -> Self
The time the session entered STOP_IN_PROGRESS state.
sourcepub fn set_stopped_at(self, input: Option<DateTime>) -> Self
pub fn set_stopped_at(self, input: Option<DateTime>) -> Self
The time the session entered STOP_IN_PROGRESS state.
sourcepub fn get_stopped_at(&self) -> &Option<DateTime>
pub fn get_stopped_at(&self) -> &Option<DateTime>
The time the session entered STOP_IN_PROGRESS state.
sourcepub fn stopped_by(self, input: impl Into<String>) -> Self
pub fn stopped_by(self, input: impl Into<String>) -> Self
The user ID of the user that stopped the streaming session.
sourcepub fn set_stopped_by(self, input: Option<String>) -> Self
pub fn set_stopped_by(self, input: Option<String>) -> Self
The user ID of the user that stopped the streaming session.
sourcepub fn get_stopped_by(&self) -> &Option<String>
pub fn get_stopped_by(&self) -> &Option<String>
The user ID of the user that stopped the streaming session.
sourcepub fn started_at(self, input: DateTime) -> Self
pub fn started_at(self, input: DateTime) -> Self
The time the session entered START_IN_PROGRESS state.
sourcepub fn set_started_at(self, input: Option<DateTime>) -> Self
pub fn set_started_at(self, input: Option<DateTime>) -> Self
The time the session entered START_IN_PROGRESS state.
sourcepub fn get_started_at(&self) -> &Option<DateTime>
pub fn get_started_at(&self) -> &Option<DateTime>
The time the session entered START_IN_PROGRESS state.
sourcepub fn started_by(self, input: impl Into<String>) -> Self
pub fn started_by(self, input: impl Into<String>) -> Self
The user ID of the user that started the streaming session.
sourcepub fn set_started_by(self, input: Option<String>) -> Self
pub fn set_started_by(self, input: Option<String>) -> Self
The user ID of the user that started the streaming session.
sourcepub fn get_started_by(&self) -> &Option<String>
pub fn get_started_by(&self) -> &Option<String>
The user ID of the user that started the streaming session.
sourcepub fn stop_at(self, input: DateTime) -> Self
pub fn stop_at(self, input: DateTime) -> Self
The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.
sourcepub fn set_stop_at(self, input: Option<DateTime>) -> Self
pub fn set_stop_at(self, input: Option<DateTime>) -> Self
The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.
sourcepub fn get_stop_at(&self) -> &Option<DateTime>
pub fn get_stop_at(&self) -> &Option<DateTime>
The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.
sourcepub fn started_from_backup_id(self, input: impl Into<String>) -> Self
pub fn started_from_backup_id(self, input: impl Into<String>) -> Self
The backup ID used to restore a streaming session.
sourcepub fn set_started_from_backup_id(self, input: Option<String>) -> Self
pub fn set_started_from_backup_id(self, input: Option<String>) -> Self
The backup ID used to restore a streaming session.
sourcepub fn get_started_from_backup_id(&self) -> &Option<String>
pub fn get_started_from_backup_id(&self) -> &Option<String>
The backup ID used to restore a streaming session.
sourcepub fn backup_mode(self, input: SessionBackupMode) -> Self
pub fn backup_mode(self, input: SessionBackupMode) -> Self
Shows the current backup setting of the session.
sourcepub fn set_backup_mode(self, input: Option<SessionBackupMode>) -> Self
pub fn set_backup_mode(self, input: Option<SessionBackupMode>) -> Self
Shows the current backup setting of the session.
sourcepub fn get_backup_mode(&self) -> &Option<SessionBackupMode>
pub fn get_backup_mode(&self) -> &Option<SessionBackupMode>
Shows the current backup setting of the session.
sourcepub fn max_backups_to_retain(self, input: i32) -> Self
pub fn max_backups_to_retain(self, input: i32) -> Self
The maximum number of backups of a streaming session that you can have. When the maximum number of backups is reached, the oldest backup is deleted.
sourcepub fn set_max_backups_to_retain(self, input: Option<i32>) -> Self
pub fn set_max_backups_to_retain(self, input: Option<i32>) -> Self
The maximum number of backups of a streaming session that you can have. When the maximum number of backups is reached, the oldest backup is deleted.
sourcepub fn get_max_backups_to_retain(&self) -> &Option<i32>
pub fn get_max_backups_to_retain(&self) -> &Option<i32>
The maximum number of backups of a streaming session that you can have. When the maximum number of backups is reached, the oldest backup is deleted.
sourcepub fn volume_retention_mode(self, input: VolumeRetentionMode) -> Self
pub fn volume_retention_mode(self, input: VolumeRetentionMode) -> Self
Determine if an EBS volume created from this streaming session will be backed up.
sourcepub fn set_volume_retention_mode(
self,
input: Option<VolumeRetentionMode>
) -> Self
pub fn set_volume_retention_mode( self, input: Option<VolumeRetentionMode> ) -> Self
Determine if an EBS volume created from this streaming session will be backed up.
sourcepub fn get_volume_retention_mode(&self) -> &Option<VolumeRetentionMode>
pub fn get_volume_retention_mode(&self) -> &Option<VolumeRetentionMode>
Determine if an EBS volume created from this streaming session will be backed up.
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 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.
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 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.
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 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.
sourcepub fn build(self) -> StreamingSession
pub fn build(self) -> StreamingSession
Consumes the builder and constructs a StreamingSession.
Trait Implementations§
source§impl Clone for StreamingSessionBuilder
impl Clone for StreamingSessionBuilder
source§fn clone(&self) -> StreamingSessionBuilder
fn clone(&self) -> StreamingSessionBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moresource§impl Debug for StreamingSessionBuilder
impl Debug for StreamingSessionBuilder
source§impl Default for StreamingSessionBuilder
impl Default for StreamingSessionBuilder
source§fn default() -> StreamingSessionBuilder
fn default() -> StreamingSessionBuilder
source§impl PartialEq for StreamingSessionBuilder
impl PartialEq for StreamingSessionBuilder
source§fn eq(&self, other: &StreamingSessionBuilder) -> bool
fn eq(&self, other: &StreamingSessionBuilder) -> bool
self and other values to be equal, and is used
by ==.impl StructuralPartialEq for StreamingSessionBuilder
Auto Trait Implementations§
impl Freeze for StreamingSessionBuilder
impl RefUnwindSafe for StreamingSessionBuilder
impl Send for StreamingSessionBuilder
impl Sync for StreamingSessionBuilder
impl Unpin for StreamingSessionBuilder
impl UnwindSafe for StreamingSessionBuilder
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> 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 more