Package software.amazon.awssdk.services.workspaces.model

Class WorkspaceDirectory

    • Method Detail

      • directoryId

        public final String directoryId()

        The directory identifier.

        Returns:
        The directory identifier.

      • alias

        public final String alias()

        The directory alias.

        Returns:
        The directory alias.

      • directoryName

        public final String directoryName()

        The name of the directory.

        Returns:
        The name of the directory.

      • registrationCode

        public final String 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:
        The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

      • hasSubnetIds

        public final boolean hasSubnetIds()
        For responses, this returns true if the service returned a value for the SubnetIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • subnetIds

        public final List<String> subnetIds()

        The identifiers of the subnets used with the directory.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubnetIds() method.

        Returns:
        The identifiers of the subnets used with the directory.

      • hasDnsIpAddresses

        public final boolean hasDnsIpAddresses()
        For responses, this returns true if the service returned a value for the DnsIpAddresses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • dnsIpAddresses

        public final List<String> dnsIpAddresses()

        The IP addresses of the DNS servers for the directory.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDnsIpAddresses() method.

        Returns:
        The IP addresses of the DNS servers for the directory.

      • customerUserName

        public final String customerUserName()

        The user name for the service account.

        Returns:
        The user name for the service account.

      • iamRoleId

        public final String 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:
        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.

      • workspaceSecurityGroupId

        public final String workspaceSecurityGroupId()

        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.

      • state

        public final WorkspaceDirectoryState state()

        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.

        If the service returns an enum value that is not available in the current SDK version, state will return WorkspaceDirectoryState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

        Returns:
        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.
        See Also:
        WorkspaceDirectoryState

      • stateAsString

        public final String stateAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, state will return WorkspaceDirectoryState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

        Returns:
        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.
        See Also:
        WorkspaceDirectoryState

      • workspaceCreationProperties

        public final DefaultWorkspaceCreationProperties workspaceCreationProperties()

        The default creation properties for all WorkSpaces in the directory.

        Returns:
        The default creation properties for all WorkSpaces in the directory.

      • hasIpGroupIds

        public final boolean hasIpGroupIds()
        For responses, this returns true if the service returned a value for the IpGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • ipGroupIds

        public final List<String> ipGroupIds()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIpGroupIds() method.

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

      • workspaceAccessProperties

        public final WorkspaceAccessProperties workspaceAccessProperties()

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

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

      • selfservicePermissions

        public final SelfservicePermissions selfservicePermissions()

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

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

      • samlProperties

        public final SamlProperties samlProperties()

        Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.

        Returns:
        Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.

      • certificateBasedAuthProperties

        public final CertificateBasedAuthProperties certificateBasedAuthProperties()

        The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.

        Returns:
        The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)