java.lang.Object
- software.amazon.awssdk.services.directory.model.DirectoryDescription

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<DirectoryDescription.Builder,DirectoryDescription>

@Generated("software.amazon.awssdk:codegen")
public final class DirectoryDescription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DirectoryDescription.Builder,DirectoryDescription>

Contains information about an Directory Service directory.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DirectoryDescription.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`accessUrl()`	The access URL for the directory, such as `http://<alias>.awsapps.com`.
`String`	`alias()`	The alias for the directory.
`static DirectoryDescription.Builder`	`builder()`
`DirectoryConnectSettingsDescription`	`connectSettings()`	A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory.
`String`	`description()`	The description for the directory.
`Integer`	`desiredNumberOfDomainControllers()`	The desired number of domain controllers in the directory if the directory is Microsoft AD.
`String`	`directoryId()`	The directory identifier.
`List<String>`	`dnsIpAddrs()`	The IP addresses of the DNS servers for the directory.
`DirectoryEdition`	`edition()`	The edition associated with this directory.
`String`	`editionAsString()`	The edition associated with this directory.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDnsIpAddrs()`	For responses, this returns true if the service returned a value for the DnsIpAddrs property.
`int`	`hashCode()`
`Instant`	`launchTime()`	Specifies when the directory was created.
`String`	`name()`	The fully qualified name of the directory.
`OSVersion`	`osVersion()`	The operating system (OS) version of the directory.
`String`	`osVersionAsString()`	The operating system (OS) version of the directory.
`OwnerDirectoryDescription`	`ownerDirectoryDescription()`	Describes the Managed Microsoft AD directory in the directory owner account.
`RadiusSettings`	`radiusSettings()`	A RadiusSettings object that contains information about the RADIUS server configured for this directory.
`RadiusStatus`	`radiusStatus()`	The status of the RADIUS MFA server connection.
`String`	`radiusStatusAsString()`	The status of the RADIUS MFA server connection.
`RegionsInfo`	`regionsInfo()`	Lists the Regions where the directory has replicated.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DirectoryDescription.Builder>`	`serializableBuilderClass()`
`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`).
`String`	`shareMethodAsString()`	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`).
`String`	`shareNotes()`	A directory share request that is sent by the directory owner to the directory consumer.
`ShareStatus`	`shareStatus()`	Current directory status of the shared Managed Microsoft AD directory.
`String`	`shareStatusAsString()`	Current directory status of the shared Managed Microsoft AD directory.
`String`	`shortName()`	The short name of the directory.
`DirectorySize`	`size()`	The directory size.
`String`	`sizeAsString()`	The directory size.
`Boolean`	`ssoEnabled()`	Indicates if single sign-on is enabled for the directory.
`DirectoryStage`	`stage()`	The current stage of the directory.
`String`	`stageAsString()`	The current stage of the directory.
`Instant`	`stageLastUpdatedDateTime()`	The date and time that the stage was last updated.
`String`	`stageReason()`	Additional information about the directory stage.
`DirectoryDescription.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`DirectoryType`	`type()`	The directory size.
`String`	`typeAsString()`	The directory size.
`DirectoryVpcSettingsDescription`	`vpcSettings()`	A DirectoryVpcSettingsDescription object that contains additional information about a directory.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - directoryId
```
public final String directoryId()
```
    The directory identifier.
    
    Returns:
    
    The directory identifier.
  - name
```
public final String name()
```
    The fully qualified name of the directory.
    
    Returns:
    
    The fully qualified name of the directory.
  - shortName
```
public final String shortName()
```
    The short name of the directory.
    
    Returns:
    
    The short name of the directory.
  - size
```
public final DirectorySize size()
```
    The directory size.
    
    If the service returns an enum value that is not available in the current SDK version, size will return DirectorySize.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sizeAsString().
    
    Returns:
    
    The directory size.
    
    See Also:
    
    DirectorySize
  - sizeAsString
```
public final String sizeAsString()
```
    The directory size.
    
    If the service returns an enum value that is not available in the current SDK version, size will return DirectorySize.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sizeAsString().
    
    Returns:
    
    The directory size.
    
    See Also:
    
    DirectorySize
  - edition
```
public final DirectoryEdition edition()
```
    The edition associated with this directory.
    
    If the service returns an enum value that is not available in the current SDK version, edition will return DirectoryEdition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from editionAsString().
    
    Returns:
    
    The edition associated with this directory.
    
    See Also:
    
    DirectoryEdition
  - editionAsString
```
public final String editionAsString()
```
    The edition associated with this directory.
    
    If the service returns an enum value that is not available in the current SDK version, edition will return DirectoryEdition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from editionAsString().
    
    Returns:
    
    The edition associated with this directory.
    
    See Also:
    
    DirectoryEdition
  - alias
```
public final 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.
    
    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.
  - accessUrl
```
public final 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.
    
    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.
  - description
```
public final String description()
```
    The description for the directory.
    
    Returns:
    
    The description for the directory.
  - hasDnsIpAddrs
```
public final boolean hasDnsIpAddrs()
```
    For responses, this returns true if the service returned a value for the DnsIpAddrs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - dnsIpAddrs
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDnsIpAddrs() method.
    
    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 your self-managed directory to which the AD Connector is connected.
  - stage
```
public final DirectoryStage stage()
```
    The current stage of the directory.
    
    If the service returns an enum value that is not available in the current SDK version, stage will return DirectoryStage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stageAsString().
    
    Returns:
    
    The current stage of the directory.
    
    See Also:
    
    DirectoryStage
  - stageAsString
```
public final String stageAsString()
```
    The current stage of the directory.
    
    If the service returns an enum value that is not available in the current SDK version, stage will return DirectoryStage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stageAsString().
    
    Returns:
    
    The current stage of the directory.
    
    See Also:
    
    DirectoryStage
  - shareStatus
```
public final ShareStatus shareStatus()
```
    Current directory status of the shared Managed Microsoft AD directory.
    
    If the service returns an enum value that is not available in the current SDK version, shareStatus will return ShareStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shareStatusAsString().
    
    Returns:
    
    Current directory status of the shared Managed Microsoft AD directory.
    
    See Also:
    
    ShareStatus
  - shareStatusAsString
```
public final String shareStatusAsString()
```
    Current directory status of the shared Managed Microsoft AD directory.
    
    If the service returns an enum value that is not available in the current SDK version, shareStatus will return ShareStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shareStatusAsString().
    
    Returns:
    
    Current directory status of the shared Managed Microsoft AD directory.
    
    See Also:
    
    ShareStatus
  - shareMethod
```
public final 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).
    
    If the service returns an enum value that is not available in the current SDK version, shareMethod will return ShareMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shareMethodAsString().
    
    Returns:
    
    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).
    
    See Also:
    
    ShareMethod
  - shareMethodAsString
```
public final String shareMethodAsString()
```
    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).
    
    If the service returns an enum value that is not available in the current SDK version, shareMethod will return ShareMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shareMethodAsString().
    
    Returns:
    
    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).
    
    See Also:
    
    ShareMethod
  - shareNotes
```
public final 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.
    
    Returns:
    
    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.
  - launchTime
```
public final Instant launchTime()
```
    Specifies when the directory was created.
    
    Returns:
    
    Specifies when the directory was created.
  - stageLastUpdatedDateTime
```
public final Instant stageLastUpdatedDateTime()
```
    The date and time that the stage was last updated.
    
    Returns:
    
    The date and time that the stage was last updated.
  - type
```
public final DirectoryType type()
```
    The directory size.
    
    If the service returns an enum value that is not available in the current SDK version, type will return DirectoryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The directory size.
    
    See Also:
    
    DirectoryType
  - typeAsString
```
public final String typeAsString()
```
    The directory size.
    
    If the service returns an enum value that is not available in the current SDK version, type will return DirectoryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The directory size.
    
    See Also:
    
    DirectoryType
  - vpcSettings
```
public final 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.
    
    Returns:
    
    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.
  - connectSettings
```
public final 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.
    
    Returns:
    
    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.
  - radiusSettings
```
public final RadiusSettings radiusSettings()
```
    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.
  - radiusStatus
```
public final RadiusStatus radiusStatus()
```
    The status of the RADIUS MFA server connection.
    
    If the service returns an enum value that is not available in the current SDK version, radiusStatus will return RadiusStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from radiusStatusAsString().
    
    Returns:
    
    The status of the RADIUS MFA server connection.
    
    See Also:
    
    RadiusStatus
  - radiusStatusAsString
```
public final String radiusStatusAsString()
```
    The status of the RADIUS MFA server connection.
    
    If the service returns an enum value that is not available in the current SDK version, radiusStatus will return RadiusStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from radiusStatusAsString().
    
    Returns:
    
    The status of the RADIUS MFA server connection.
    
    See Also:
    
    RadiusStatus
  - stageReason
```
public final String stageReason()
```
    Additional information about the directory stage.
    
    Returns:
    
    Additional information about the directory stage.
  - ssoEnabled
```
public final Boolean ssoEnabled()
```
    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.
  - desiredNumberOfDomainControllers
```
public final Integer desiredNumberOfDomainControllers()
```
    The desired number of domain controllers in the directory if the directory is Microsoft AD.
    
    Returns:
    
    The desired number of domain controllers in the directory if the directory is Microsoft AD.
  - ownerDirectoryDescription
```
public final OwnerDirectoryDescription ownerDirectoryDescription()
```
    Describes the Managed Microsoft AD directory in the directory owner account.
    
    Returns:
    
    Describes the Managed Microsoft AD directory in the directory owner account.
  - regionsInfo
```
public final RegionsInfo regionsInfo()
```
    Lists the Regions where the directory has replicated.
    
    Returns:
    
    Lists the Regions where the directory has replicated.
  - osVersion
```
public final OSVersion osVersion()
```
    The operating system (OS) version of the directory.
    
    If the service returns an enum value that is not available in the current SDK version, osVersion will return OSVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from osVersionAsString().
    
    Returns:
    
    The operating system (OS) version of the directory.
    
    See Also:
    
    OSVersion
  - osVersionAsString
```
public final String osVersionAsString()
```
    The operating system (OS) version of the directory.
    
    If the service returns an enum value that is not available in the current SDK version, osVersion will return OSVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from osVersionAsString().
    
    Returns:
    
    The operating system (OS) version of the directory.
    
    See Also:
    
    OSVersion
  - toBuilder
```
public DirectoryDescription.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DirectoryDescription.Builder,DirectoryDescription>
  - builder
```
public static DirectoryDescription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DirectoryDescription.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DirectoryDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

directoryId

name

shortName

size

sizeAsString

edition

editionAsString

alias

accessUrl

description

hasDnsIpAddrs

dnsIpAddrs

stage

stageAsString

shareStatus

shareStatusAsString

shareMethod

shareMethodAsString

shareNotes

launchTime

stageLastUpdatedDateTime

type

typeAsString

vpcSettings

connectSettings

radiusSettings

radiusStatus

radiusStatusAsString

stageReason

ssoEnabled

desiredNumberOfDomainControllers

ownerDirectoryDescription

regionsInfo

osVersion

osVersionAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields