NAME
Paws::WorkSpaces::WorkspaceDirectory
USAGE
This class represents one of two things:
Arguments in a call to a service
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::WorkSpaces::WorkspaceDirectory object:
$service_obj->Method(Att1 => { Alias => $value, ..., WorkspaceSecurityGroupId => $value });
Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::WorkSpaces::WorkspaceDirectory object:
$result = $service_obj->Method(...);
$result->Att1->Alias
DESCRIPTION
Describes a directory that is used with Amazon WorkSpaces.
ATTRIBUTES
Alias => Str
The directory alias.
CustomerUserName => Str
The user name for the service account.
DirectoryId => Str
The directory identifier.
DirectoryName => Str
The name of the directory.
DirectoryType => Str
The directory type.
DnsIpAddresses => ArrayRef[Str|Undef]
The IP addresses of the DNS servers for the directory.
IamRoleId => 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.
IpGroupIds => ArrayRef[Str|Undef]
The identifiers of the IP access control groups associated with the directory.
RegistrationCode => 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.
SelfservicePermissions => Paws::WorkSpaces::SelfservicePermissions
The default self-service permissions for WorkSpaces in the directory.
State => Str
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 (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceDirectories.html). If the directory ID isn't returned, then the directory has been successfully deregistered.
SubnetIds => ArrayRef[Str|Undef]
The identifiers of the subnets used with the directory.
Tenancy => Str
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 (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html).
WorkspaceAccessProperties => Paws::WorkSpaces::WorkspaceAccessProperties
The devices and operating systems that users can use to access WorkSpaces.
WorkspaceCreationProperties => Paws::WorkSpaces::DefaultWorkspaceCreationProperties
The default creation properties for all WorkSpaces in the directory.
WorkspaceSecurityGroupId => Str
The identifier of the security group that is assigned to new WorkSpaces.
SEE ALSO
This class forms part of Paws, describing an object used in Paws::WorkSpaces
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues