Struct aws_sdk_workspaces::model::WorkspaceCreationProperties

#[non_exhaustive]
pub struct WorkspaceCreationProperties {
    pub enable_work_docs: Option<bool>,
    pub enable_internet_access: Option<bool>,
    pub default_ou: Option<String>,
    pub custom_security_group_id: Option<String>,
    pub user_enabled_as_local_administrator: Option<bool>,
    pub enable_maintenance_mode: Option<bool>,
}

Describes the default properties that are used for creating WorkSpaces. For more information, see Update Directory Details for Your 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.

enable_work_docs: Option<bool>

Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.

If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.

If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.

enable_internet_access: Option<bool>

Indicates whether internet access is enabled for your WorkSpaces.

default_ou: Option<String>

The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form "OU=value,DC=value,DC=value", where value is any string of characters, and the number of domain components (DCs) is two or more. For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.

• To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation.

• The API doesn't validate whether the OU exists.

custom_security_group_id: Option<String>

The identifier of your custom security group.

user_enabled_as_local_administrator: Option<bool>

Indicates whether users are local administrators of their WorkSpaces.

enable_maintenance_mode: Option<bool>

Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.

Implementations

impl WorkspaceCreationProperties

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

Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.

If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.

If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.

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

Indicates whether internet access is enabled for your WorkSpaces.

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

The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form "OU=value,DC=value,DC=value", where value is any string of characters, and the number of domain components (DCs) is two or more. For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.

• To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation.

• The API doesn't validate whether the OU exists.

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

The identifier of your custom security group.

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

Indicates whether users are local administrators of their WorkSpaces.

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

Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.

impl WorkspaceCreationProperties

pub fn builder() -> Builder

Creates a new builder-style object to manufacture WorkspaceCreationProperties

Trait Implementations

impl Clone for WorkspaceCreationProperties

fn clone(&self) -> WorkspaceCreationProperties

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WorkspaceCreationProperties

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

Formats the value using the given formatter.

impl PartialEq<WorkspaceCreationProperties> for WorkspaceCreationProperties

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

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

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

This method tests for !=.

impl StructuralPartialEq for WorkspaceCreationProperties