Package software.amazon.awssdk.services.directory.model

Interface DirectoryDescription.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DirectoryDescription.Builder,DirectoryDescription>, SdkBuilder<DirectoryDescription.Builder,DirectoryDescription>, SdkPojo
Enclosing class:
DirectoryDescription
public static interface DirectoryDescription.Builder extends SdkPojo, CopyableBuilder<DirectoryDescription.Builder,DirectoryDescription>

  • Method Details

    • 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.

    • size

      DirectoryDescription.Builder size(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:

    • size

      DirectoryDescription.Builder size(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:

    • edition

      DirectoryDescription.Builder edition(String edition)

      The edition associated with this directory.

      Parameters:
      edition - The edition associated with this directory.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • edition

      DirectoryDescription.Builder edition(DirectoryEdition edition)

      The edition associated with this directory.

      Parameters:
      edition - The edition associated with this directory.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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.

    • stage

      DirectoryDescription.Builder stage(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:

    • stage

      DirectoryDescription.Builder stage(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:

    • 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

      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:

    • 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

      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:

    • 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.

    • type

      DirectoryDescription.Builder type(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:

    • type

      DirectoryDescription.Builder type(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:

    • vpcSettings

      DirectoryDescription.Builder vpcSettings(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 Microsoft 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 Microsoft AD directory.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcSettings

      default DirectoryDescription.Builder vpcSettings(Consumer<DirectoryVpcSettingsDescription.Builder> 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 Microsoft AD directory.

      This is a convenience method that creates an instance of the DirectoryVpcSettingsDescription.Builder avoiding the need to create one manually via DirectoryVpcSettingsDescription.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcSettings(DirectoryVpcSettingsDescription).

      Parameters:
      vpcSettings - a consumer that will call methods on DirectoryVpcSettingsDescription.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • connectSettings

      DirectoryDescription.Builder connectSettings(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.

    • connectSettings

      default DirectoryDescription.Builder connectSettings(Consumer<DirectoryConnectSettingsDescription.Builder> 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.

      This is a convenience method that creates an instance of the DirectoryConnectSettingsDescription.Builder avoiding the need to create one manually via DirectoryConnectSettingsDescription.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to connectSettings(DirectoryConnectSettingsDescription).

      Parameters:
      connectSettings - a consumer that will call methods on DirectoryConnectSettingsDescription.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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.

    • radiusSettings

      default DirectoryDescription.Builder radiusSettings(Consumer<RadiusSettings.Builder> radiusSettings)

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

      This is a convenience method that creates an instance of the RadiusSettings.Builder avoiding the need to create one manually via RadiusSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to radiusSettings(RadiusSettings).

      Parameters:
      radiusSettings - a consumer that will call methods on RadiusSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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

      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:

    • 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.

    • ownerDirectoryDescription

      default DirectoryDescription.Builder ownerDirectoryDescription(Consumer<OwnerDirectoryDescription.Builder> ownerDirectoryDescription)

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

      This is a convenience method that creates an instance of the OwnerDirectoryDescription.Builder avoiding the need to create one manually via OwnerDirectoryDescription.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ownerDirectoryDescription(OwnerDirectoryDescription).

      Parameters:
      ownerDirectoryDescription - a consumer that will call methods on OwnerDirectoryDescription.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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.

    • regionsInfo

      default DirectoryDescription.Builder regionsInfo(Consumer<RegionsInfo.Builder> regionsInfo)

      Lists the Regions where the directory has replicated.

      This is a convenience method that creates an instance of the RegionsInfo.Builder avoiding the need to create one manually via RegionsInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to regionsInfo(RegionsInfo).

      Parameters:
      regionsInfo - a consumer that will call methods on RegionsInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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

      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: