Interface DirectoryDescription.Builder

    • Method Detail

      • directoryId

        DirectoryDescription.Builder directoryId​(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.
      • name

        DirectoryDescription.Builder name​(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.
      • shortName

        DirectoryDescription.Builder shortName​(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.
      • alias

        DirectoryDescription.Builder alias​(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.
      • accessUrl

        DirectoryDescription.Builder accessUrl​(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.
      • description

        DirectoryDescription.Builder description​(String description)

        The description for the directory.

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

        DirectoryDescription.Builder dnsIpAddrs​(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 your self-managed 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 your self-managed directory to which the AD Connector is connected.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • dnsIpAddrs

        DirectoryDescription.Builder dnsIpAddrs​(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 your self-managed 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 your self-managed directory to which the AD Connector is connected.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • shareStatus

        DirectoryDescription.Builder shareStatus​(String shareStatus)

        Current directory status of the shared Managed Microsoft AD directory.

        Parameters:
        shareStatus - Current directory status of the shared Managed Microsoft AD directory.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ShareStatus, ShareStatus
      • shareStatus

        DirectoryDescription.Builder shareStatus​(ShareStatus shareStatus)

        Current directory status of the shared Managed Microsoft AD directory.

        Parameters:
        shareStatus - Current directory status of the shared Managed Microsoft AD directory.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ShareStatus, ShareStatus
      • shareMethod

        DirectoryDescription.Builder shareMethod​(String shareMethod)

        The method used when sharing a directory to determine whether the directory should be shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account by sending a shared directory request (HANDSHAKE).

        Parameters:
        shareMethod - The method used when sharing a directory to determine whether the directory should be shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account by sending a shared directory request (HANDSHAKE).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ShareMethod, ShareMethod
      • shareMethod

        DirectoryDescription.Builder shareMethod​(ShareMethod shareMethod)

        The method used when sharing a directory to determine whether the directory should be shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account by sending a shared directory request (HANDSHAKE).

        Parameters:
        shareMethod - The method used when sharing a directory to determine whether the directory should be shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account by sending a shared directory request (HANDSHAKE).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ShareMethod, ShareMethod
      • shareNotes

        DirectoryDescription.Builder shareNotes​(String shareNotes)

        A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation.

        Parameters:
        shareNotes - A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • launchTime

        DirectoryDescription.Builder launchTime​(Instant 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.
      • stageLastUpdatedDateTime

        DirectoryDescription.Builder stageLastUpdatedDateTime​(Instant 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.
      • radiusSettings

        DirectoryDescription.Builder radiusSettings​(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.
      • radiusStatus

        DirectoryDescription.Builder radiusStatus​(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, RadiusStatus
      • radiusStatus

        DirectoryDescription.Builder radiusStatus​(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, RadiusStatus
      • stageReason

        DirectoryDescription.Builder stageReason​(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.
      • ssoEnabled

        DirectoryDescription.Builder ssoEnabled​(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.
      • desiredNumberOfDomainControllers

        DirectoryDescription.Builder desiredNumberOfDomainControllers​(Integer desiredNumberOfDomainControllers)

        The desired number of domain controllers in the directory if the directory is Microsoft AD.

        Parameters:
        desiredNumberOfDomainControllers - The desired number of domain controllers in the directory if the directory is Microsoft AD.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • ownerDirectoryDescription

        DirectoryDescription.Builder ownerDirectoryDescription​(OwnerDirectoryDescription ownerDirectoryDescription)

        Describes the Managed Microsoft AD directory in the directory owner account.

        Parameters:
        ownerDirectoryDescription - Describes the Managed Microsoft AD directory in the directory owner account.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • regionsInfo

        DirectoryDescription.Builder regionsInfo​(RegionsInfo regionsInfo)

        Lists the Regions where the directory has replicated.

        Parameters:
        regionsInfo - Lists the Regions where the directory has replicated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • osVersion

        DirectoryDescription.Builder osVersion​(String osVersion)

        The operating system (OS) version of the directory.

        Parameters:
        osVersion - The operating system (OS) version of the directory.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        OSVersion, OSVersion
      • osVersion

        DirectoryDescription.Builder osVersion​(OSVersion osVersion)

        The operating system (OS) version of the directory.

        Parameters:
        osVersion - The operating system (OS) version of the directory.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        OSVersion, OSVersion