Struct aws_sdk_workspaces::model::WorkspaceDirectory

#[non_exhaustive]
pub struct WorkspaceDirectory {

    pub directory_id: Option<String>,
    pub alias: Option<String>,
    pub directory_name: Option<String>,
    pub registration_code: Option<String>,
    pub subnet_ids: Option<Vec<String>>,
    pub dns_ip_addresses: Option<Vec<String>>,
    pub customer_user_name: Option<String>,
    pub iam_role_id: Option<String>,
    pub directory_type: Option<WorkspaceDirectoryType>,
    pub workspace_security_group_id: Option<String>,
    pub state: Option<WorkspaceDirectoryState>,
    pub workspace_creation_properties: Option<DefaultWorkspaceCreationProperties>,
    pub ip_group_ids: Option<Vec<String>>,
    pub workspace_access_properties: Option<WorkspaceAccessProperties>,
    pub tenancy: Option<Tenancy>,
    pub selfservice_permissions: Option<SelfservicePermissions>,
}

Describes a directory that is used with Amazon 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.

directory_id: Option<String>

The directory identifier.

alias: Option<String>

The directory alias.

directory_name: Option<String>

The name of the directory.

registration_code: Option<String>

The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

subnet_ids: Option<Vec<String>>

The identifiers of the subnets used with the directory.

dns_ip_addresses: Option<Vec<String>>

The IP addresses of the DNS servers for the directory.

customer_user_name: Option<String>

The user name for the service account.

iam_role_id: Option<String>

The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.

directory_type: Option<WorkspaceDirectoryType>

The directory type.

workspace_security_group_id: Option<String>

The identifier of the security group that is assigned to new WorkSpaces.

state: Option<WorkspaceDirectoryState>

The state of the directory's registration with Amazon WorkSpaces. After a directory is deregistered, the DEREGISTERED state is returned very briefly before the directory metadata is cleaned up, so this state is rarely returned. To confirm that a directory is deregistered, check for the directory ID by using DescribeWorkspaceDirectories. If the directory ID isn't returned, then the directory has been successfully deregistered.

workspace_creation_properties: Option<DefaultWorkspaceCreationProperties>

The default creation properties for all WorkSpaces in the directory.

ip_group_ids: Option<Vec<String>>

The identifiers of the IP access control groups associated with the directory.

workspace_access_properties: Option<WorkspaceAccessProperties>

The devices and operating systems that users can use to access WorkSpaces.

tenancy: Option<Tenancy>

Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this value must be set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.

selfservice_permissions: Option<SelfservicePermissions>

The default self-service permissions for WorkSpaces in the directory.

Implementations

impl WorkspaceDirectory

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

The directory identifier.

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

The directory alias.

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

The name of the directory.

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

The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

pub fn subnet_ids(&self) -> Option<&[String]>

The identifiers of the subnets used with the directory.

pub fn dns_ip_addresses(&self) -> Option<&[String]>

The IP addresses of the DNS servers for the directory.

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

The user name for the service account.

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

The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.

pub fn directory_type(&self) -> Option<&WorkspaceDirectoryType>

The directory type.

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

The identifier of the security group that is assigned to new WorkSpaces.

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

The state of the directory's registration with Amazon WorkSpaces. After a directory is deregistered, the DEREGISTERED state is returned very briefly before the directory metadata is cleaned up, so this state is rarely returned. To confirm that a directory is deregistered, check for the directory ID by using DescribeWorkspaceDirectories. If the directory ID isn't returned, then the directory has been successfully deregistered.

pub fn workspace_creation_properties(
    &self
) -> Option<&DefaultWorkspaceCreationProperties>

The default creation properties for all WorkSpaces in the directory.

pub fn ip_group_ids(&self) -> Option<&[String]>

The identifiers of the IP access control groups associated with the directory.

pub fn workspace_access_properties(&self) -> Option<&WorkspaceAccessProperties>

The devices and operating systems that users can use to access WorkSpaces.

pub fn tenancy(&self) -> Option<&Tenancy>

Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this value must be set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.

pub fn selfservice_permissions(&self) -> Option<&SelfservicePermissions>

The default self-service permissions for WorkSpaces in the directory.

impl WorkspaceDirectory

pub fn builder() -> Builder

Creates a new builder-style object to manufacture WorkspaceDirectory

Trait Implementations

impl Clone for WorkspaceDirectory

fn clone(&self) -> WorkspaceDirectory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WorkspaceDirectory

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

Formats the value using the given formatter.

impl PartialEq<WorkspaceDirectory> for WorkspaceDirectory

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

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

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

This method tests for !=.

impl StructuralPartialEq for WorkspaceDirectory