Struct aws_sdk_appstream::types::builders::SessionBuilder

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

A builder for Session.

Implementations

impl SessionBuilder

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

The identifier of the streaming session.

This field is required.

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

The identifier of the streaming session.

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

The identifier of the streaming session.

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

The identifier of the user for whom the session was created.

This field is required.

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

The identifier of the user for whom the session was created.

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

The identifier of the user for whom the session was created.

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

The name of the stack for the streaming session.

This field is required.

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

The name of the stack for the streaming session.

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

The name of the stack for the streaming session.

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

The name of the fleet for the streaming session.

This field is required.

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

The name of the fleet for the streaming session.

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

The name of the fleet for the streaming session.

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

The current state of the streaming session.

This field is required.

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

The current state of the streaming session.

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

The current state of the streaming session.

pub fn connection_state(self, input: SessionConnectionState) -> Self

Specifies whether a user is connected to the streaming session.

pub fn set_connection_state(self, input: Option<SessionConnectionState>) -> Self

Specifies whether a user is connected to the streaming session.

pub fn get_connection_state(&self) -> &Option<SessionConnectionState>

Specifies whether a user is connected to the streaming session.

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

The time when a streaming instance is dedicated for the user.

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

The time when a streaming instance is dedicated for the user.

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

The time when a streaming instance is dedicated for the user.

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

The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime, when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.

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

The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime, when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.

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

The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime, when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.

pub fn authentication_type(self, input: AuthenticationType) -> Self

The authentication method. The user is authenticated using a streaming URL (API) or SAML 2.0 federation (SAML).

pub fn set_authentication_type(self, input: Option<AuthenticationType>) -> Self

The authentication method. The user is authenticated using a streaming URL (API) or SAML 2.0 federation (SAML).

pub fn get_authentication_type(&self) -> &Option<AuthenticationType>

The authentication method. The user is authenticated using a streaming URL (API) or SAML 2.0 federation (SAML).

pub fn network_access_configuration( self, input: NetworkAccessConfiguration ) -> Self

The network details for the streaming session.

pub fn set_network_access_configuration( self, input: Option<NetworkAccessConfiguration> ) -> Self

The network details for the streaming session.

pub fn get_network_access_configuration( &self ) -> &Option<NetworkAccessConfiguration>

The network details for the streaming session.

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

The identifier for the instance hosting the session.

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

The identifier for the instance hosting the session.

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

The identifier for the instance hosting the session.

pub fn build(self) -> Session

Consumes the builder and constructs a Session.

Trait Implementations

impl Clone for SessionBuilder

fn clone(&self) -> SessionBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SessionBuilder

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

Formats the value using the given formatter.

impl Default for SessionBuilder

fn default() -> SessionBuilder

Returns the “default value” for a type.

impl PartialEq for SessionBuilder

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