Class DirectoryDescription

    • Constructor Detail

      • DirectoryDescription

        public DirectoryDescription()
    • Method Detail

      • setDirectoryId

        public void setDirectoryId​(String directoryId)

        The directory identifier.

        Parameters:
        directoryId - The directory identifier.
      • getDirectoryId

        public String getDirectoryId()

        The directory identifier.

        Returns:
        The directory identifier.
      • withDirectoryId

        public DirectoryDescription withDirectoryId​(String directoryId)

        The directory identifier.

        Parameters:
        directoryId - The directory identifier.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setName

        public void setName​(String name)

        The fully-qualified name of the directory.

        Parameters:
        name - The fully-qualified name of the directory.
      • getName

        public String getName()

        The fully-qualified name of the directory.

        Returns:
        The fully-qualified name of the directory.
      • withName

        public DirectoryDescription withName​(String name)

        The fully-qualified name of the directory.

        Parameters:
        name - The fully-qualified name of the directory.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setShortName

        public void setShortName​(String shortName)

        The short name of the directory.

        Parameters:
        shortName - The short name of the directory.
      • getShortName

        public String getShortName()

        The short name of the directory.

        Returns:
        The short name of the directory.
      • withShortName

        public DirectoryDescription withShortName​(String shortName)

        The short name of the directory.

        Parameters:
        shortName - The short name of the directory.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setSize

        public void setSize​(String size)

        The directory size.

        Parameters:
        size - The directory size.
        See Also:
        DirectorySize
      • getSize

        public String getSize()

        The directory size.

        Returns:
        The directory size.
        See Also:
        DirectorySize
      • withSize

        public DirectoryDescription withSize​(String size)

        The directory size.

        Parameters:
        size - The directory size.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DirectorySize
      • setSize

        public void setSize​(DirectorySize size)

        The directory size.

        Parameters:
        size - The directory size.
        See Also:
        DirectorySize
      • withSize

        public DirectoryDescription withSize​(DirectorySize size)

        The directory size.

        Parameters:
        size - The directory size.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DirectorySize
      • setAlias

        public void setAlias​(String alias)

        The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as d-XXXXXXXXXX.

        Parameters:
        alias - The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as d-XXXXXXXXXX.
      • getAlias

        public String getAlias()

        The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as d-XXXXXXXXXX.

        Returns:
        The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as d-XXXXXXXXXX.
      • withAlias

        public DirectoryDescription withAlias​(String alias)

        The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as d-XXXXXXXXXX.

        Parameters:
        alias - The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as d-XXXXXXXXXX.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setAccessUrl

        public void setAccessUrl​(String accessUrl)

        The access URL for the directory, such as http://alias.awsapps.com . If no alias has been created for the directory, alias is the directory identifier, such as d-XXXXXXXXXX.

        Parameters:
        accessUrl - The access URL for the directory, such as http://alias.awsapps.com . If no alias has been created for the directory, alias is the directory identifier, such as d-XXXXXXXXXX.
      • getAccessUrl

        public String getAccessUrl()

        The access URL for the directory, such as http://alias.awsapps.com . If no alias has been created for the directory, alias is the directory identifier, such as d-XXXXXXXXXX.

        Returns:
        The access URL for the directory, such as http://alias.awsapps.com . If no alias has been created for the directory, alias is the directory identifier, such as d-XXXXXXXXXX.
      • withAccessUrl

        public DirectoryDescription withAccessUrl​(String accessUrl)

        The access URL for the directory, such as http://alias.awsapps.com . If no alias has been created for the directory, alias is the directory identifier, such as d-XXXXXXXXXX.

        Parameters:
        accessUrl - The access URL for the directory, such as http://alias.awsapps.com . If no alias has been created for the directory, alias is the directory identifier, such as d-XXXXXXXXXX.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setDescription

        public void setDescription​(String description)

        The textual description for the directory.

        Parameters:
        description - The textual description for the directory.
      • getDescription

        public String getDescription()

        The textual description for the directory.

        Returns:
        The textual description for the directory.
      • withDescription

        public DirectoryDescription withDescription​(String description)

        The textual description for the directory.

        Parameters:
        description - The textual description for the directory.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getDnsIpAddrs

        public List<String> getDnsIpAddrs()

        The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in the on-premises directory to which the AD Connector is connected.

        Returns:
        The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in the on-premises directory to which the AD Connector is connected.
      • setDnsIpAddrs

        public void setDnsIpAddrs​(Collection<String> dnsIpAddrs)

        The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in the on-premises directory to which the AD Connector is connected.

        Parameters:
        dnsIpAddrs - The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in the on-premises directory to which the AD Connector is connected.
      • withDnsIpAddrs

        public DirectoryDescription withDnsIpAddrs​(String... dnsIpAddrs)

        The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in the on-premises directory to which the AD Connector is connected.

        NOTE: This method appends the values to the existing list (if any). Use setDnsIpAddrs(java.util.Collection) or withDnsIpAddrs(java.util.Collection) if you want to override the existing values.

        Parameters:
        dnsIpAddrs - The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in the on-premises directory to which the AD Connector is connected.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withDnsIpAddrs

        public DirectoryDescription withDnsIpAddrs​(Collection<String> dnsIpAddrs)

        The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in the on-premises directory to which the AD Connector is connected.

        Parameters:
        dnsIpAddrs - The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in the on-premises directory to which the AD Connector is connected.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setStage

        public void setStage​(String stage)

        The current stage of the directory.

        Parameters:
        stage - The current stage of the directory.
        See Also:
        DirectoryStage
      • getStage

        public String getStage()

        The current stage of the directory.

        Returns:
        The current stage of the directory.
        See Also:
        DirectoryStage
      • withStage

        public DirectoryDescription withStage​(String stage)

        The current stage of the directory.

        Parameters:
        stage - The current stage of the directory.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DirectoryStage
      • setStage

        public void setStage​(DirectoryStage stage)

        The current stage of the directory.

        Parameters:
        stage - The current stage of the directory.
        See Also:
        DirectoryStage
      • withStage

        public DirectoryDescription withStage​(DirectoryStage stage)

        The current stage of the directory.

        Parameters:
        stage - The current stage of the directory.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DirectoryStage
      • setLaunchTime

        public void setLaunchTime​(Date launchTime)

        Specifies when the directory was created.

        Parameters:
        launchTime - Specifies when the directory was created.
      • getLaunchTime

        public Date getLaunchTime()

        Specifies when the directory was created.

        Returns:
        Specifies when the directory was created.
      • withLaunchTime

        public DirectoryDescription withLaunchTime​(Date launchTime)

        Specifies when the directory was created.

        Parameters:
        launchTime - Specifies when the directory was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setStageLastUpdatedDateTime

        public void setStageLastUpdatedDateTime​(Date stageLastUpdatedDateTime)

        The date and time that the stage was last updated.

        Parameters:
        stageLastUpdatedDateTime - The date and time that the stage was last updated.
      • getStageLastUpdatedDateTime

        public Date getStageLastUpdatedDateTime()

        The date and time that the stage was last updated.

        Returns:
        The date and time that the stage was last updated.
      • withStageLastUpdatedDateTime

        public DirectoryDescription withStageLastUpdatedDateTime​(Date stageLastUpdatedDateTime)

        The date and time that the stage was last updated.

        Parameters:
        stageLastUpdatedDateTime - The date and time that the stage was last updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setType

        public void setType​(String type)

        The directory size.

        Parameters:
        type - The directory size.
        See Also:
        DirectoryType
      • getType

        public String getType()

        The directory size.

        Returns:
        The directory size.
        See Also:
        DirectoryType
      • withType

        public DirectoryDescription withType​(String type)

        The directory size.

        Parameters:
        type - The directory size.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DirectoryType
      • setType

        public void setType​(DirectoryType type)

        The directory size.

        Parameters:
        type - The directory size.
        See Also:
        DirectoryType
      • withType

        public DirectoryDescription withType​(DirectoryType type)

        The directory size.

        Parameters:
        type - The directory size.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DirectoryType
      • setVpcSettings

        public void setVpcSettings​(DirectoryVpcSettingsDescription vpcSettings)

        A DirectoryVpcSettingsDescription object that contains additional information about a directory. This member is only present if the directory is a Simple AD or Managed AD directory.

        Parameters:
        vpcSettings - A DirectoryVpcSettingsDescription object that contains additional information about a directory. This member is only present if the directory is a Simple AD or Managed AD directory.
      • withVpcSettings

        public DirectoryDescription withVpcSettings​(DirectoryVpcSettingsDescription vpcSettings)

        A DirectoryVpcSettingsDescription object that contains additional information about a directory. This member is only present if the directory is a Simple AD or Managed AD directory.

        Parameters:
        vpcSettings - A DirectoryVpcSettingsDescription object that contains additional information about a directory. This member is only present if the directory is a Simple AD or Managed AD directory.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withConnectSettings

        public DirectoryDescription withConnectSettings​(DirectoryConnectSettingsDescription connectSettings)

        A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory. This member is only present if the directory is an AD Connector directory.

        Parameters:
        connectSettings - A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory. This member is only present if the directory is an AD Connector directory.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setRadiusSettings

        public void setRadiusSettings​(RadiusSettings radiusSettings)

        A RadiusSettings object that contains information about the RADIUS server configured for this directory.

        Parameters:
        radiusSettings - A RadiusSettings object that contains information about the RADIUS server configured for this directory.
      • getRadiusSettings

        public RadiusSettings getRadiusSettings()

        A RadiusSettings object that contains information about the RADIUS server configured for this directory.

        Returns:
        A RadiusSettings object that contains information about the RADIUS server configured for this directory.
      • withRadiusSettings

        public DirectoryDescription withRadiusSettings​(RadiusSettings radiusSettings)

        A RadiusSettings object that contains information about the RADIUS server configured for this directory.

        Parameters:
        radiusSettings - A RadiusSettings object that contains information about the RADIUS server configured for this directory.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setRadiusStatus

        public void setRadiusStatus​(String radiusStatus)

        The status of the RADIUS MFA server connection.

        Parameters:
        radiusStatus - The status of the RADIUS MFA server connection.
        See Also:
        RadiusStatus
      • getRadiusStatus

        public String getRadiusStatus()

        The status of the RADIUS MFA server connection.

        Returns:
        The status of the RADIUS MFA server connection.
        See Also:
        RadiusStatus
      • withRadiusStatus

        public DirectoryDescription withRadiusStatus​(String radiusStatus)

        The status of the RADIUS MFA server connection.

        Parameters:
        radiusStatus - The status of the RADIUS MFA server connection.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RadiusStatus
      • setRadiusStatus

        public void setRadiusStatus​(RadiusStatus radiusStatus)

        The status of the RADIUS MFA server connection.

        Parameters:
        radiusStatus - The status of the RADIUS MFA server connection.
        See Also:
        RadiusStatus
      • withRadiusStatus

        public DirectoryDescription withRadiusStatus​(RadiusStatus radiusStatus)

        The status of the RADIUS MFA server connection.

        Parameters:
        radiusStatus - The status of the RADIUS MFA server connection.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RadiusStatus
      • setStageReason

        public void setStageReason​(String stageReason)

        Additional information about the directory stage.

        Parameters:
        stageReason - Additional information about the directory stage.
      • getStageReason

        public String getStageReason()

        Additional information about the directory stage.

        Returns:
        Additional information about the directory stage.
      • withStageReason

        public DirectoryDescription withStageReason​(String stageReason)

        Additional information about the directory stage.

        Parameters:
        stageReason - Additional information about the directory stage.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setSsoEnabled

        public void setSsoEnabled​(Boolean ssoEnabled)

        Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.

        Parameters:
        ssoEnabled - Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.
      • getSsoEnabled

        public Boolean getSsoEnabled()

        Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.

        Returns:
        Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.
      • withSsoEnabled

        public DirectoryDescription withSsoEnabled​(Boolean ssoEnabled)

        Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.

        Parameters:
        ssoEnabled - Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • isSsoEnabled

        public Boolean isSsoEnabled()

        Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.

        Returns:
        Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.
      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object