Struct WorkspacesPool

#[non_exhaustive]
pub struct WorkspacesPool {

    pub pool_id: String,
    pub pool_arn: String,
    pub capacity_status: Option<CapacityStatus>,
    pub pool_name: String,
    pub description: Option<String>,
    pub state: WorkspacesPoolState,
    pub created_at: DateTime,
    pub bundle_id: String,
    pub directory_id: String,
    pub errors: Option<Vec<WorkspacesPoolError>>,
    pub application_settings: Option<ApplicationSettingsResponse>,
    pub timeout_settings: Option<TimeoutSettings>,
    pub running_mode: PoolsRunningMode,
}

Describes a pool of WorkSpaces.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

pool_id: String

The identifier of a pool.

pool_arn: String

The Amazon Resource Name (ARN) for the pool.

capacity_status: Option<CapacityStatus>

The capacity status for the pool

pool_name: String

The name of the pool.

description: Option<String>

The description of the pool.

state: WorkspacesPoolState

The current state of the pool.

created_at: DateTime

The time the pool was created.

bundle_id: String

The identifier of the bundle used by the pool.

directory_id: String

The identifier of the directory used by the pool.

errors: Option<Vec<WorkspacesPoolError>>

The pool errors.

application_settings: Option<ApplicationSettingsResponse>

The persistent application settings for users of the pool.

timeout_settings: Option<TimeoutSettings>

The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.

running_mode: PoolsRunningMode

The running mode of the pool.

Implementations

impl WorkspacesPool

pub fn pool_id(&self) -> &str

The identifier of a pool.

pub fn pool_arn(&self) -> &str

The Amazon Resource Name (ARN) for the pool.

pub fn capacity_status(&self) -> Option<&CapacityStatus>

The capacity status for the pool

pub fn pool_name(&self) -> &str

The name of the pool.

pub fn description(&self) -> Option<&str>

The description of the pool.

pub fn state(&self) -> &WorkspacesPoolState

The current state of the pool.

pub fn created_at(&self) -> &DateTime

The time the pool was created.

pub fn bundle_id(&self) -> &str

The identifier of the bundle used by the pool.

pub fn directory_id(&self) -> &str

The identifier of the directory used by the pool.

pub fn errors(&self) -> &[WorkspacesPoolError]

The pool errors.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .errors.is_none().

pub fn application_settings(&self) -> Option<&ApplicationSettingsResponse>

The persistent application settings for users of the pool.

pub fn timeout_settings(&self) -> Option<&TimeoutSettings>

The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.

pub fn running_mode(&self) -> &PoolsRunningMode

The running mode of the pool.

impl WorkspacesPool

pub fn builder() -> WorkspacesPoolBuilder

Creates a new builder-style object to manufacture WorkspacesPool.

Trait Implementations

impl Clone for WorkspacesPool

fn clone(&self) -> WorkspacesPool

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WorkspacesPool

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

Formats the value using the given formatter.

impl PartialEq for WorkspacesPool

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for WorkspacesPool