Struct aws_sdk_workspaces::model::Workspace

#[non_exhaustive]
pub struct Workspace {

    pub workspace_id: Option<String>,
    pub directory_id: Option<String>,
    pub user_name: Option<String>,
    pub ip_address: Option<String>,
    pub state: Option<WorkspaceState>,
    pub bundle_id: Option<String>,
    pub subnet_id: Option<String>,
    pub error_message: Option<String>,
    pub error_code: Option<String>,
    pub computer_name: Option<String>,
    pub volume_encryption_key: Option<String>,
    pub user_volume_encryption_enabled: Option<bool>,
    pub root_volume_encryption_enabled: Option<bool>,
    pub workspace_properties: Option<WorkspaceProperties>,
    pub modification_states: Option<Vec<ModificationState>>,
}

Describes a WorkSpace.

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.

workspace_id: Option<String>

The identifier of the WorkSpace.

directory_id: Option<String>

The identifier of the Directory Service directory for the WorkSpace.

user_name: Option<String>

The user for the WorkSpace.

ip_address: Option<String>

The IP address of the WorkSpace.

state: Option<WorkspaceState>

The operational state of the WorkSpace.

After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.

bundle_id: Option<String>

The identifier of the bundle used to create the WorkSpace.

subnet_id: Option<String>

The identifier of the subnet for the WorkSpace.

error_message: Option<String>

The text of the error message that is returned if the WorkSpace cannot be created.

error_code: Option<String>

The error code that is returned if the WorkSpace cannot be created.

computer_name: Option<String>

The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.

volume_encryption_key: Option<String>

The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.

user_volume_encryption_enabled: Option<bool>

Indicates whether the data stored on the user volume is encrypted.

root_volume_encryption_enabled: Option<bool>

Indicates whether the data stored on the root volume is encrypted.

workspace_properties: Option<WorkspaceProperties>

The properties of the WorkSpace.

modification_states: Option<Vec<ModificationState>>

The modification states of the WorkSpace.

Implementations

impl Workspace

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

The identifier of the WorkSpace.

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

The identifier of the Directory Service directory for the WorkSpace.

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

The user for the WorkSpace.

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

The IP address of the WorkSpace.

pub fn state(&self) -> Option<&WorkspaceState>

The operational state of the WorkSpace.

After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.

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

The identifier of the bundle used to create the WorkSpace.

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

The identifier of the subnet for the WorkSpace.

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

The text of the error message that is returned if the WorkSpace cannot be created.

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

The error code that is returned if the WorkSpace cannot be created.

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

The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.

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

The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.

pub fn user_volume_encryption_enabled(&self) -> Option<bool>

Indicates whether the data stored on the user volume is encrypted.

pub fn root_volume_encryption_enabled(&self) -> Option<bool>

Indicates whether the data stored on the root volume is encrypted.

pub fn workspace_properties(&self) -> Option<&WorkspaceProperties>

The properties of the WorkSpace.

pub fn modification_states(&self) -> Option<&[ModificationState]>

The modification states of the WorkSpace.

impl Workspace

pub fn builder() -> Builder

Creates a new builder-style object to manufacture Workspace

Trait Implementations

impl Clone for Workspace

fn clone(&self) -> Workspace

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Workspace

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

Formats the value using the given formatter.

impl PartialEq<Workspace> for Workspace

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

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

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

This method tests for !=.

impl StructuralPartialEq for Workspace