DirectoryDescription.Builder (AWS SDK for Java

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 Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`DirectoryDescription.Builder`	`accessUrl(String accessUrl)` The access URL for the directory, such as `http://<alias>.awsapps.com`.
`DirectoryDescription.Builder`	`alias(String alias)` The alias for the directory.
`default DirectoryDescription.Builder`	`connectSettings(Consumer<DirectoryConnectSettingsDescription.Builder> connectSettings)` A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory.
`DirectoryDescription.Builder`	`connectSettings(DirectoryConnectSettingsDescription connectSettings)` A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory.
`DirectoryDescription.Builder`	`description(String description)` The textual description for the directory.
`DirectoryDescription.Builder`	`desiredNumberOfDomainControllers(Integer desiredNumberOfDomainControllers)` The desired number of domain controllers in the directory if the directory is Microsoft AD.
`DirectoryDescription.Builder`	`directoryId(String directoryId)` The directory identifier.
`DirectoryDescription.Builder`	`dnsIpAddrs(Collection<String> dnsIpAddrs)` The IP addresses of the DNS servers for the directory.
`DirectoryDescription.Builder`	`dnsIpAddrs(String... dnsIpAddrs)` The IP addresses of the DNS servers for the directory.
`DirectoryDescription.Builder`	`edition(DirectoryEdition edition)` The edition associated with this directory.
`DirectoryDescription.Builder`	`edition(String edition)` The edition associated with this directory.
`DirectoryDescription.Builder`	`launchTime(Instant launchTime)` Specifies when the directory was created.
`DirectoryDescription.Builder`	`name(String name)` The fully qualified name of the directory.
`default DirectoryDescription.Builder`	`ownerDirectoryDescription(Consumer<OwnerDirectoryDescription.Builder> ownerDirectoryDescription)` Describes the AWS Managed Microsoft AD directory in the directory owner account.
`DirectoryDescription.Builder`	`ownerDirectoryDescription(OwnerDirectoryDescription ownerDirectoryDescription)` Describes the AWS Managed Microsoft AD directory in the directory owner account.
`default DirectoryDescription.Builder`	`radiusSettings(Consumer<RadiusSettings.Builder> radiusSettings)` A RadiusSettings object that contains information about the RADIUS server configured for this directory.
`DirectoryDescription.Builder`	`radiusSettings(RadiusSettings radiusSettings)` A RadiusSettings object that contains information about the RADIUS server configured for this directory.
`DirectoryDescription.Builder`	`radiusStatus(RadiusStatus radiusStatus)` The status of the RADIUS MFA server connection.
`DirectoryDescription.Builder`	`radiusStatus(String radiusStatus)` The status of the RADIUS MFA server connection.
`DirectoryDescription.Builder`	`shareMethod(ShareMethod shareMethod)` The method used when sharing a directory to determine whether the directory should be shared within your AWS organization (`ORGANIZATIONS`) or with any AWS account by sending a shared directory request ( `HANDSHAKE`).
`DirectoryDescription.Builder`	`shareMethod(String shareMethod)` The method used when sharing a directory to determine whether the directory should be shared within your AWS organization (`ORGANIZATIONS`) or with any AWS account by sending a shared directory request ( `HANDSHAKE`).
`DirectoryDescription.Builder`	`shareNotes(String shareNotes)` A directory share request that is sent by the directory owner to the directory consumer.
`DirectoryDescription.Builder`	`shareStatus(ShareStatus shareStatus)` Current directory status of the shared AWS Managed Microsoft AD directory.
`DirectoryDescription.Builder`	`shareStatus(String shareStatus)` Current directory status of the shared AWS Managed Microsoft AD directory.
`DirectoryDescription.Builder`	`shortName(String shortName)` The short name of the directory.
`DirectoryDescription.Builder`	`size(DirectorySize size)` The directory size.
`DirectoryDescription.Builder`	`size(String size)` The directory size.
`DirectoryDescription.Builder`	`ssoEnabled(Boolean ssoEnabled)` Indicates if single sign-on is enabled for the directory.
`DirectoryDescription.Builder`	`stage(DirectoryStage stage)` The current stage of the directory.
`DirectoryDescription.Builder`	`stage(String stage)` The current stage of the directory.
`DirectoryDescription.Builder`	`stageLastUpdatedDateTime(Instant stageLastUpdatedDateTime)` The date and time that the stage was last updated.
`DirectoryDescription.Builder`	`stageReason(String stageReason)` Additional information about the directory stage.
`DirectoryDescription.Builder`	`type(DirectoryType type)` The directory size.
`DirectoryDescription.Builder`	`type(String type)` The directory size.
`default DirectoryDescription.Builder`	`vpcSettings(Consumer<DirectoryVpcSettingsDescription.Builder> vpcSettings)` A DirectoryVpcSettingsDescription object that contains additional information about a directory.
`DirectoryDescription.Builder`	`vpcSettings(DirectoryVpcSettingsDescription vpcSettings)` A DirectoryVpcSettingsDescription object that contains additional information about a directory.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- 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.
  - 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:
    
    DirectorySize, DirectorySize
  - 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:
    
    DirectorySize, DirectorySize
  - 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:
    
    DirectoryEdition, DirectoryEdition
  - 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:
    
    DirectoryEdition, DirectoryEdition
  - 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 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.
  - 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 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.
  - 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 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.
  - 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:
    
    DirectoryStage, DirectoryStage
  - 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:
    
    DirectoryStage, DirectoryStage
  - shareStatus
```
DirectoryDescription.Builder shareStatus(String shareStatus)
```
    Current directory status of the shared AWS Managed Microsoft AD directory.
    
    Parameters:
    
    shareStatus - Current directory status of the shared AWS 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 AWS Managed Microsoft AD directory.
    
    Parameters:
    
    shareStatus - Current directory status of the shared AWS 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 AWS organization (ORGANIZATIONS) or with any AWS 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 AWS organization (ORGANIZATIONS) or with any AWS 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 AWS organization (ORGANIZATIONS) or with any AWS 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 AWS organization (ORGANIZATIONS) or with any AWS 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.
  - 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:
    
    DirectoryType, DirectoryType
  - 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:
    
    DirectoryType, DirectoryType
  - 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 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.
  - 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 AD directory.
    This is a convenience 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:
    
    vpcSettings(DirectoryVpcSettingsDescription)
  - 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 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:
    
    connectSettings(DirectoryConnectSettingsDescription)
  - 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 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:
    
    radiusSettings(RadiusSettings)
  - 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 AWS Managed Microsoft AD directory in the directory owner account.
    
    Parameters:
    
    ownerDirectoryDescription - Describes the AWS 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 AWS Managed Microsoft AD directory in the directory owner account.
    This is a convenience 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:
    
    ownerDirectoryDescription(OwnerDirectoryDescription)

Interface DirectoryDescription.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

directoryId

name

shortName

size

size

edition

edition

alias

accessUrl

description

dnsIpAddrs

dnsIpAddrs

stage

stage

shareStatus

shareStatus

shareMethod

shareMethod

shareNotes

launchTime

stageLastUpdatedDateTime

type

type

vpcSettings

vpcSettings

connectSettings

connectSettings

radiusSettings

radiusSettings

radiusStatus

radiusStatus

stageReason

ssoEnabled

desiredNumberOfDomainControllers

ownerDirectoryDescription

ownerDirectoryDescription