#[non_exhaustive]
pub struct StreamingSessionBuilder { /* private fields */ }
Expand description

A builder for StreamingSession.

Implementations§

source§

impl StreamingSessionBuilder

source

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.

source

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.

source

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.

source

pub fn created_at(self, input: DateTime) -> Self

The ISO timestamp in seconds for when the resource was created.

source

pub fn set_created_at(self, input: Option<DateTime>) -> Self

The ISO timestamp in seconds for when the resource was created.

source

pub fn get_created_at(&self) -> &Option<DateTime>

The ISO timestamp in seconds for when the resource was created.

source

pub fn created_by(self, input: impl Into<String>) -> Self

The user ID of the user that created the streaming session.

source

pub fn set_created_by(self, input: Option<String>) -> Self

The user ID of the user that created the streaming session.

source

pub fn get_created_by(&self) -> &Option<String>

The user ID of the user that created the streaming session.

source

pub fn ec2_instance_type(self, input: impl Into<String>) -> Self

The EC2 Instance type used for the streaming session.

source

pub fn set_ec2_instance_type(self, input: Option<String>) -> Self

The EC2 Instance type used for the streaming session.

source

pub fn get_ec2_instance_type(&self) -> &Option<String>

The EC2 Instance type used for the streaming session.

source

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.

source

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.

source

pub fn get_launch_profile_id(&self) -> &Option<String>

The ID of the launch profile used to control access from the streaming session.

source

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.

source

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.

source

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.

source

pub fn session_id(self, input: impl Into<String>) -> Self

The session ID.

source

pub fn set_session_id(self, input: Option<String>) -> Self

The session ID.

source

pub fn get_session_id(&self) -> &Option<String>

The session ID.

source

pub fn state(self, input: StreamingSessionState) -> Self

The current state.

source

pub fn set_state(self, input: Option<StreamingSessionState>) -> Self

The current state.

source

pub fn get_state(&self) -> &Option<StreamingSessionState>

The current state.

source

pub fn status_code(self, input: StreamingSessionStatusCode) -> Self

The status code.

source

pub fn set_status_code(self, input: Option<StreamingSessionStatusCode>) -> Self

The status code.

source

pub fn get_status_code(&self) -> &Option<StreamingSessionStatusCode>

The status code.

source

pub fn status_message(self, input: impl Into<String>) -> Self

The status message for the streaming session.

source

pub fn set_status_message(self, input: Option<String>) -> Self

The status message for the streaming session.

source

pub fn get_status_message(&self) -> &Option<String>

The status message for the streaming session.

source

pub fn streaming_image_id(self, input: impl Into<String>) -> Self

The ID of the streaming image.

source

pub fn set_streaming_image_id(self, input: Option<String>) -> Self

The ID of the streaming image.

source

pub fn get_streaming_image_id(&self) -> &Option<String>

The ID of the streaming image.

source

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

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.

source

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

A collection of labels, in the form of key-value pairs, that apply to this resource.

source

pub fn get_tags(&self) -> &Option<HashMap<String, String>>

A collection of labels, in the form of key-value pairs, that apply to this resource.

source

pub fn terminate_at(self, input: DateTime) -> Self

The time the streaming session will automatically terminate if not terminated by the user.

source

pub fn set_terminate_at(self, input: Option<DateTime>) -> Self

The time the streaming session will automatically terminate if not terminated by the user.

source

pub fn get_terminate_at(&self) -> &Option<DateTime>

The time the streaming session will automatically terminate if not terminated by the user.

source

pub fn updated_at(self, input: DateTime) -> Self

The ISO timestamp in seconds for when the resource was updated.

source

pub fn set_updated_at(self, input: Option<DateTime>) -> Self

The ISO timestamp in seconds for when the resource was updated.

source

pub fn get_updated_at(&self) -> &Option<DateTime>

The ISO timestamp in seconds for when the resource was updated.

source

pub fn updated_by(self, input: impl Into<String>) -> Self

The user ID of the user that most recently updated the resource.

source

pub fn set_updated_by(self, input: Option<String>) -> Self

The user ID of the user that most recently updated the resource.

source

pub fn get_updated_by(&self) -> &Option<String>

The user ID of the user that most recently updated the resource.

source

pub fn stopped_at(self, input: DateTime) -> Self

The time the session entered STOP_IN_PROGRESS state.

source

pub fn set_stopped_at(self, input: Option<DateTime>) -> Self

The time the session entered STOP_IN_PROGRESS state.

source

pub fn get_stopped_at(&self) -> &Option<DateTime>

The time the session entered STOP_IN_PROGRESS state.

source

pub fn stopped_by(self, input: impl Into<String>) -> Self

The user ID of the user that stopped the streaming session.

source

pub fn set_stopped_by(self, input: Option<String>) -> Self

The user ID of the user that stopped the streaming session.

source

pub fn get_stopped_by(&self) -> &Option<String>

The user ID of the user that stopped the streaming session.

source

pub fn started_at(self, input: DateTime) -> Self

The time the session entered START_IN_PROGRESS state.

source

pub fn set_started_at(self, input: Option<DateTime>) -> Self

The time the session entered START_IN_PROGRESS state.

source

pub fn get_started_at(&self) -> &Option<DateTime>

The time the session entered START_IN_PROGRESS state.

source

pub fn started_by(self, input: impl Into<String>) -> Self

The user ID of the user that started the streaming session.

source

pub fn set_started_by(self, input: Option<String>) -> Self

The user ID of the user that started the streaming session.

source

pub fn get_started_by(&self) -> &Option<String>

The user ID of the user that started the streaming session.

source

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.

source

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.

source

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.

source

pub fn started_from_backup_id(self, input: impl Into<String>) -> Self

The backup ID used to restore a streaming session.

source

pub fn set_started_from_backup_id(self, input: Option<String>) -> Self

The backup ID used to restore a streaming session.

source

pub fn get_started_from_backup_id(&self) -> &Option<String>

The backup ID used to restore a streaming session.

source

pub fn backup_mode(self, input: SessionBackupMode) -> Self

Shows the current backup setting of the session.

source

pub fn set_backup_mode(self, input: Option<SessionBackupMode>) -> Self

Shows the current backup setting of the session.

source

pub fn get_backup_mode(&self) -> &Option<SessionBackupMode>

Shows the current backup setting of the session.

source

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.

source

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.

source

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.

source

pub fn volume_retention_mode(self, input: VolumeRetentionMode) -> Self

Determine if an EBS volume created from this streaming session will be backed up.

source

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.

source

pub fn get_volume_retention_mode(&self) -> &Option<VolumeRetentionMode>

Determine if an EBS volume created from this streaming session will be backed up.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

pub fn build(self) -> StreamingSession

Consumes the builder and constructs a StreamingSession.

Trait Implementations§

source§

impl Clone for StreamingSessionBuilder

source§

fn clone(&self) -> StreamingSessionBuilder

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for StreamingSessionBuilder

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for StreamingSessionBuilder

source§

fn default() -> StreamingSessionBuilder

Returns the “default value” for a type. Read more
source§

impl PartialEq for StreamingSessionBuilder

source§

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

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

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

impl StructuralPartialEq for StreamingSessionBuilder

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more