WorkspaceDirectory class

Describes a directory that is used with Amazon WorkSpaces.

  • @JsonSerializable(includeIfNull: false, explicitToJson: true, createFactory: true, createToJson: false)


WorkspaceDirectory({String alias, String customerUserName, String directoryId, String directoryName, WorkspaceDirectoryType directoryType, List<String> dnsIpAddresses, String iamRoleId, String registrationCode, SelfservicePermissions selfservicePermissions, WorkspaceDirectoryState state, List<String> subnetIds, Tenancy tenancy, WorkspaceAccessProperties workspaceAccessProperties, DefaultWorkspaceCreationProperties workspaceCreationProperties, String workspaceSecurityGroupId, List<String> ipGroupIds})
WorkspaceDirectory.fromJson(Map<String, dynamic> json)


alias String
The directory alias.
@JsonKey(name: 'Alias'), final
customerUserName String
The user name for the service account.
@JsonKey(name: 'CustomerUserName'), final
directoryId String
The directory identifier.
@JsonKey(name: 'DirectoryId'), final
directoryName String
The name of the directory.
@JsonKey(name: 'DirectoryName'), final
directoryType WorkspaceDirectoryType
The directory type.
@JsonKey(name: 'DirectoryType'), final
dnsIpAddresses List<String>
The IP addresses of the DNS servers for the directory.
@JsonKey(name: 'DnsIpAddresses'), final
hashCode int
The hash code for this object. [...]
read-only, inherited
iamRoleId 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.
@JsonKey(name: 'IamRoleId'), final
ipGroupIds List<String>
The identifiers of the IP access control groups associated with the directory.
@JsonKey(name: 'ipGroupIds'), final
registrationCode 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.
@JsonKey(name: 'RegistrationCode'), final
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
selfservicePermissions SelfservicePermissions
The default self-service permissions for WorkSpaces in the directory.
@JsonKey(name: 'SelfservicePermissions'), final
state 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.
@JsonKey(name: 'State'), final
subnetIds List<String>
The identifiers of the subnets used with the directory.
@JsonKey(name: 'SubnetIds'), final
tenancy 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.
@JsonKey(name: 'Tenancy'), final
workspaceAccessProperties WorkspaceAccessProperties
The devices and operating systems that users can use to access WorkSpaces.
@JsonKey(name: 'WorkspaceAccessProperties'), final
workspaceCreationProperties DefaultWorkspaceCreationProperties
The default creation properties for all WorkSpaces in the directory.
@JsonKey(name: 'WorkspaceCreationProperties'), final
workspaceSecurityGroupId String
The identifier of the security group that is assigned to new WorkSpaces.
@JsonKey(name: 'WorkspaceSecurityGroupId'), final


noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
toString() String
A string representation of this object. [...]


operator ==(Object other) bool
The equality operator. [...]