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 Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description DirectoryDescription.BuilderaccessUrl(String accessUrl)The access URL for the directory, such ashttp://<alias>.awsapps.com.DirectoryDescription.Builderalias(String alias)The alias for the directory.default DirectoryDescription.BuilderconnectSettings(Consumer<DirectoryConnectSettingsDescription.Builder> connectSettings)A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory.DirectoryDescription.BuilderconnectSettings(DirectoryConnectSettingsDescription connectSettings)A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory.DirectoryDescription.Builderdescription(String description)The description for the directory.DirectoryDescription.BuilderdesiredNumberOfDomainControllers(Integer desiredNumberOfDomainControllers)The desired number of domain controllers in the directory if the directory is Microsoft AD.DirectoryDescription.BuilderdirectoryId(String directoryId)The directory identifier.DirectoryDescription.BuilderdnsIpAddrs(String... dnsIpAddrs)The IP addresses of the DNS servers for the directory.DirectoryDescription.BuilderdnsIpAddrs(Collection<String> dnsIpAddrs)The IP addresses of the DNS servers for the directory.DirectoryDescription.Builderedition(String edition)The edition associated with this directory.DirectoryDescription.Builderedition(DirectoryEdition edition)The edition associated with this directory.DirectoryDescription.BuilderlaunchTime(Instant launchTime)Specifies when the directory was created.DirectoryDescription.Buildername(String name)The fully qualified name of the directory.DirectoryDescription.BuilderosVersion(String osVersion)The operating system (OS) version of the directory.DirectoryDescription.BuilderosVersion(OSVersion osVersion)The operating system (OS) version of the directory.default DirectoryDescription.BuilderownerDirectoryDescription(Consumer<OwnerDirectoryDescription.Builder> ownerDirectoryDescription)Describes the Managed Microsoft AD directory in the directory owner account.DirectoryDescription.BuilderownerDirectoryDescription(OwnerDirectoryDescription ownerDirectoryDescription)Describes the Managed Microsoft AD directory in the directory owner account.default DirectoryDescription.BuilderradiusSettings(Consumer<RadiusSettings.Builder> radiusSettings)A RadiusSettings object that contains information about the RADIUS server configured for this directory.DirectoryDescription.BuilderradiusSettings(RadiusSettings radiusSettings)A RadiusSettings object that contains information about the RADIUS server configured for this directory.DirectoryDescription.BuilderradiusStatus(String radiusStatus)The status of the RADIUS MFA server connection.DirectoryDescription.BuilderradiusStatus(RadiusStatus radiusStatus)The status of the RADIUS MFA server connection.default DirectoryDescription.BuilderregionsInfo(Consumer<RegionsInfo.Builder> regionsInfo)Lists the Regions where the directory has replicated.DirectoryDescription.BuilderregionsInfo(RegionsInfo regionsInfo)Lists the Regions where the directory has replicated.DirectoryDescription.BuildershareMethod(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).DirectoryDescription.BuildershareMethod(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).DirectoryDescription.BuildershareNotes(String shareNotes)A directory share request that is sent by the directory owner to the directory consumer.DirectoryDescription.BuildershareStatus(String shareStatus)Current directory status of the shared Managed Microsoft AD directory.DirectoryDescription.BuildershareStatus(ShareStatus shareStatus)Current directory status of the shared Managed Microsoft AD directory.DirectoryDescription.BuildershortName(String shortName)The short name of the directory.DirectoryDescription.Buildersize(String size)The directory size.DirectoryDescription.Buildersize(DirectorySize size)The directory size.DirectoryDescription.BuilderssoEnabled(Boolean ssoEnabled)Indicates if single sign-on is enabled for the directory.DirectoryDescription.Builderstage(String stage)The current stage of the directory.DirectoryDescription.Builderstage(DirectoryStage stage)The current stage of the directory.DirectoryDescription.BuilderstageLastUpdatedDateTime(Instant stageLastUpdatedDateTime)The date and time that the stage was last updated.DirectoryDescription.BuilderstageReason(String stageReason)Additional information about the directory stage.DirectoryDescription.Buildertype(String type)The directory size.DirectoryDescription.Buildertype(DirectoryType type)The directory size.default DirectoryDescription.BuildervpcSettings(Consumer<DirectoryVpcSettingsDescription.Builder> vpcSettings)A DirectoryVpcSettingsDescription object that contains additional information about a directory.DirectoryDescription.BuildervpcSettings(DirectoryVpcSettingsDescription vpcSettings)A DirectoryVpcSettingsDescription object that contains additional information about a directory.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
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 asd-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 asd-XXXXXXXXXX.- Parameters:
accessUrl- The access URL for the directory, such ashttp://<alias>.awsapps.com. If no alias has been created for the directory,<alias>is the directory identifier, such asd-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:
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 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.
-
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 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 theDirectoryVpcSettingsDescription.Builderavoiding the need to create one manually viaDirectoryVpcSettingsDescription.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tovpcSettings(DirectoryVpcSettingsDescription).- Parameters:
vpcSettings- a consumer that will call methods onDirectoryVpcSettingsDescription.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 method that creates an instance of theDirectoryConnectSettingsDescription.Builderavoiding the need to create one manually viaDirectoryConnectSettingsDescription.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toconnectSettings(DirectoryConnectSettingsDescription).- Parameters:
connectSettings- a consumer that will call methods onDirectoryConnectSettingsDescription.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 method that creates an instance of theRadiusSettings.Builderavoiding the need to create one manually viaRadiusSettings.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toradiusSettings(RadiusSettings).- Parameters:
radiusSettings- a consumer that will call methods onRadiusSettings.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 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 theOwnerDirectoryDescription.Builderavoiding the need to create one manually viaOwnerDirectoryDescription.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toownerDirectoryDescription(OwnerDirectoryDescription).- Parameters:
ownerDirectoryDescription- a consumer that will call methods onOwnerDirectoryDescription.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ownerDirectoryDescription(OwnerDirectoryDescription)
-
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 theRegionsInfo.Builderavoiding the need to create one manually viaRegionsInfo.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toregionsInfo(RegionsInfo).- Parameters:
regionsInfo- a consumer that will call methods onRegionsInfo.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
regionsInfo(RegionsInfo)
-
osVersion
DirectoryDescription.Builder osVersion(String osVersion)
The operating system (OS) version of the directory.
-
osVersion
DirectoryDescription.Builder osVersion(OSVersion osVersion)
The operating system (OS) version of the directory.
-
-