Class WorkspaceDirectory
- All Implemented Interfaces:
Serializable
,Cloneable
Contains information about an AWS Directory Service directory for use with Amazon WorkSpaces.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
getAlias()
The directory alias.The user name for the service account.The directory identifier.The name of the directory.The directory type.An array of strings that contains the IP addresses of the DNS servers for the directory.The identifier of the IAM role.The registration code for the directory.getState()
The state of the directory's registration with Amazon WorkSpacesAn array of strings that contains the identifiers of the subnets used with the directory.A structure that specifies the default creation properties for all WorkSpaces in the directory.The identifier of the security group that is assigned to new WorkSpaces.int
hashCode()
void
The directory alias.void
setCustomerUserName
(String customerUserName) The user name for the service account.void
setDirectoryId
(String directoryId) The directory identifier.void
setDirectoryName
(String directoryName) The name of the directory.void
setDirectoryType
(WorkspaceDirectoryType directoryType) The directory type.void
setDirectoryType
(String directoryType) The directory type.void
setDnsIpAddresses
(Collection<String> dnsIpAddresses) An array of strings that contains the IP addresses of the DNS servers for the directory.void
setIamRoleId
(String iamRoleId) The identifier of the IAM role.void
setRegistrationCode
(String registrationCode) The registration code for the directory.void
setState
(WorkspaceDirectoryState state) The state of the directory's registration with Amazon WorkSpacesvoid
The state of the directory's registration with Amazon WorkSpacesvoid
setSubnetIds
(Collection<String> subnetIds) An array of strings that contains the identifiers of the subnets used with the directory.void
setWorkspaceCreationProperties
(DefaultWorkspaceCreationProperties workspaceCreationProperties) A structure that specifies the default creation properties for all WorkSpaces in the directory.void
setWorkspaceSecurityGroupId
(String workspaceSecurityGroupId) The identifier of the security group that is assigned to new WorkSpaces.toString()
Returns a string representation of this object; useful for testing and debugging.The directory alias.withCustomerUserName
(String customerUserName) The user name for the service account.withDirectoryId
(String directoryId) The directory identifier.withDirectoryName
(String directoryName) The name of the directory.withDirectoryType
(WorkspaceDirectoryType directoryType) The directory type.withDirectoryType
(String directoryType) The directory type.withDnsIpAddresses
(String... dnsIpAddresses) An array of strings that contains the IP addresses of the DNS servers for the directory.withDnsIpAddresses
(Collection<String> dnsIpAddresses) An array of strings that contains the IP addresses of the DNS servers for the directory.withIamRoleId
(String iamRoleId) The identifier of the IAM role.withRegistrationCode
(String registrationCode) The registration code for the directory.withState
(WorkspaceDirectoryState state) The state of the directory's registration with Amazon WorkSpacesThe state of the directory's registration with Amazon WorkSpaceswithSubnetIds
(String... subnetIds) An array of strings that contains the identifiers of the subnets used with the directory.withSubnetIds
(Collection<String> subnetIds) An array of strings that contains the identifiers of the subnets used with the directory.withWorkspaceCreationProperties
(DefaultWorkspaceCreationProperties workspaceCreationProperties) A structure that specifies the default creation properties for all WorkSpaces in the directory.withWorkspaceSecurityGroupId
(String workspaceSecurityGroupId) The identifier of the security group that is assigned to new WorkSpaces.
-
Constructor Details
-
WorkspaceDirectory
public WorkspaceDirectory()
-
-
Method Details
-
setDirectoryId
The directory identifier.
- Parameters:
directoryId
- The directory identifier.
-
getDirectoryId
The directory identifier.
- Returns:
- The directory identifier.
-
withDirectoryId
The directory identifier.
- Parameters:
directoryId
- The directory identifier.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAlias
The directory alias.
- Parameters:
alias
- The directory alias.
-
getAlias
The directory alias.
- Returns:
- The directory alias.
-
withAlias
The directory alias.
- Parameters:
alias
- The directory alias.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDirectoryName
The name of the directory.
- Parameters:
directoryName
- The name of the directory.
-
getDirectoryName
The name of the directory.
- Returns:
- The name of the directory.
-
withDirectoryName
The name of the directory.
- Parameters:
directoryName
- The name of the directory.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setRegistrationCode
The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
- Parameters:
registrationCode
- The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
-
getRegistrationCode
The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
- Returns:
- The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
-
withRegistrationCode
The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
- Parameters:
registrationCode
- The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getSubnetIds
An array of strings that contains the identifiers of the subnets used with the directory.
- Returns:
- An array of strings that contains the identifiers of the subnets used with the directory.
-
setSubnetIds
An array of strings that contains the identifiers of the subnets used with the directory.
- Parameters:
subnetIds
- An array of strings that contains the identifiers of the subnets used with the directory.
-
withSubnetIds
An array of strings that contains the identifiers of the subnets used with the directory.
NOTE: This method appends the values to the existing list (if any). Use
setSubnetIds(java.util.Collection)
orwithSubnetIds(java.util.Collection)
if you want to override the existing values.- Parameters:
subnetIds
- An array of strings that contains the identifiers of the subnets used with the directory.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withSubnetIds
An array of strings that contains the identifiers of the subnets used with the directory.
- Parameters:
subnetIds
- An array of strings that contains the identifiers of the subnets used with the directory.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getDnsIpAddresses
An array of strings that contains the IP addresses of the DNS servers for the directory.
- Returns:
- An array of strings that contains the IP addresses of the DNS servers for the directory.
-
setDnsIpAddresses
An array of strings that contains the IP addresses of the DNS servers for the directory.
- Parameters:
dnsIpAddresses
- An array of strings that contains the IP addresses of the DNS servers for the directory.
-
withDnsIpAddresses
An array of strings that contains the IP addresses of the DNS servers for the directory.
NOTE: This method appends the values to the existing list (if any). Use
setDnsIpAddresses(java.util.Collection)
orwithDnsIpAddresses(java.util.Collection)
if you want to override the existing values.- Parameters:
dnsIpAddresses
- An array of strings that contains the IP addresses of the DNS servers for the directory.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withDnsIpAddresses
An array of strings that contains the IP addresses of the DNS servers for the directory.
- Parameters:
dnsIpAddresses
- An array of strings that contains the IP addresses of the DNS servers for the directory.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCustomerUserName
The user name for the service account.
- Parameters:
customerUserName
- The user name for the service account.
-
getCustomerUserName
The user name for the service account.
- Returns:
- The user name for the service account.
-
withCustomerUserName
The user name for the service account.
- Parameters:
customerUserName
- The user name for the service account.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIamRoleId
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.
- Parameters:
iamRoleId
- 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.
-
getIamRoleId
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.
- Returns:
- 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.
-
withIamRoleId
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.
- Parameters:
iamRoleId
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDirectoryType
The directory type.
- Parameters:
directoryType
- The directory type.- See Also:
-
getDirectoryType
The directory type.
- Returns:
- The directory type.
- See Also:
-
withDirectoryType
The directory type.
- Parameters:
directoryType
- The directory type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setDirectoryType
The directory type.
- Parameters:
directoryType
- The directory type.- See Also:
-
withDirectoryType
The directory type.
- Parameters:
directoryType
- The directory type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setWorkspaceSecurityGroupId
The identifier of the security group that is assigned to new WorkSpaces.
- Parameters:
workspaceSecurityGroupId
- The identifier of the security group that is assigned to new WorkSpaces.
-
getWorkspaceSecurityGroupId
The identifier of the security group that is assigned to new WorkSpaces.
- Returns:
- The identifier of the security group that is assigned to new WorkSpaces.
-
withWorkspaceSecurityGroupId
The identifier of the security group that is assigned to new WorkSpaces.
- Parameters:
workspaceSecurityGroupId
- The identifier of the security group that is assigned to new WorkSpaces.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setState
The state of the directory's registration with Amazon WorkSpaces
- Parameters:
state
- The state of the directory's registration with Amazon WorkSpaces- See Also:
-
getState
The state of the directory's registration with Amazon WorkSpaces
- Returns:
- The state of the directory's registration with Amazon WorkSpaces
- See Also:
-
withState
The state of the directory's registration with Amazon WorkSpaces
- Parameters:
state
- The state of the directory's registration with Amazon WorkSpaces- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setState
The state of the directory's registration with Amazon WorkSpaces
- Parameters:
state
- The state of the directory's registration with Amazon WorkSpaces- See Also:
-
withState
The state of the directory's registration with Amazon WorkSpaces
- Parameters:
state
- The state of the directory's registration with Amazon WorkSpaces- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setWorkspaceCreationProperties
public void setWorkspaceCreationProperties(DefaultWorkspaceCreationProperties workspaceCreationProperties) A structure that specifies the default creation properties for all WorkSpaces in the directory.
- Parameters:
workspaceCreationProperties
- A structure that specifies the default creation properties for all WorkSpaces in the directory.
-
getWorkspaceCreationProperties
A structure that specifies the default creation properties for all WorkSpaces in the directory.
- Returns:
- A structure that specifies the default creation properties for all WorkSpaces in the directory.
-
withWorkspaceCreationProperties
public WorkspaceDirectory withWorkspaceCreationProperties(DefaultWorkspaceCreationProperties workspaceCreationProperties) A structure that specifies the default creation properties for all WorkSpaces in the directory.
- Parameters:
workspaceCreationProperties
- A structure that specifies the default creation properties for all WorkSpaces in the directory.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-