DirectoryDescription (AWS SDK for Java

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

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

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

Contains information about an AWS Directory Service directory.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DirectoryDescription.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DirectoryDescription.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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 textual 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)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Instant`	`launchTime()` Specifies when the directory was created.
`String`	`name()` The fully qualified name of the directory.
`OwnerDirectoryDescription`	`ownerDirectoryDescription()` Describes the AWS 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.
`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 AWS organization (`ORGANIZATIONS`) or with any AWS 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 AWS organization (`ORGANIZATIONS`) or with any AWS 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 AWS Managed Microsoft AD directory.
`String`	`shareStatusAsString()` Current directory status of the shared AWS 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()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`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
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - directoryId
```
public String directoryId()
```
    The directory identifier.
    
    Returns:
    
    The directory identifier.
  - name
```
public String name()
```
    The fully qualified name of the directory.
    
    Returns:
    
    The fully qualified name of the directory.
  - shortName
```
public String shortName()
```
    The short name of the directory.
    
    Returns:
    
    The short name of the directory.
  - size
```
public 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 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 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 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 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 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 String description()
```
    The textual description for the directory.
    
    Returns:
    
    The textual description for the directory.
  - dnsIpAddrs
```
public 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 the on-premises directory to which the AD Connector is connected.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    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 the on-premises directory to which the AD Connector is connected.
  - stage
```
public 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 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 ShareStatus shareStatus()
```
    Current directory status of the shared AWS 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 AWS Managed Microsoft AD directory.
    
    See Also:
    
    ShareStatus
  - shareStatusAsString
```
public String shareStatusAsString()
```
    Current directory status of the shared AWS 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 AWS Managed Microsoft AD directory.
    
    See Also:
    
    ShareStatus
  - shareMethod
```
public 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).
    
    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 AWS organization (ORGANIZATIONS) or with any AWS account by sending a shared directory request (HANDSHAKE).
    
    See Also:
    
    ShareMethod
  - shareMethodAsString
```
public String shareMethodAsString()
```
    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).
    
    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 AWS organization (ORGANIZATIONS) or with any AWS account by sending a shared directory request (HANDSHAKE).
    
    See Also:
    
    ShareMethod
  - shareNotes
```
public 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 Instant launchTime()
```
    Specifies when the directory was created.
    
    Returns:
    
    Specifies when the directory was created.
  - stageLastUpdatedDateTime
```
public 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 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 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 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.
    
    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 AD directory.
  - connectSettings
```
public 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 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 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 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 String stageReason()
```
    Additional information about the directory stage.
    
    Returns:
    
    Additional information about the directory stage.
  - ssoEnabled
```
public 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 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 OwnerDirectoryDescription ownerDirectoryDescription()
```
    Describes the AWS Managed Microsoft AD directory in the directory owner account.
    
    Returns:
    
    Describes the AWS Managed Microsoft AD directory in the directory owner account.
  - toBuilder
```
public DirectoryDescription.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DirectoryDescription.Builder,DirectoryDescription>
    
    Returns:
    
    a builder for type T
  - builder
```
public static DirectoryDescription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DirectoryDescription.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

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

dnsIpAddrs

stage

stageAsString

shareStatus

shareStatusAsString

shareMethod

shareMethodAsString

shareNotes

launchTime

stageLastUpdatedDateTime

type

typeAsString

vpcSettings

connectSettings

radiusSettings

radiusStatus

radiusStatusAsString

stageReason

ssoEnabled

desiredNumberOfDomainControllers

ownerDirectoryDescription

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields