public class DirectoryDescription extends Object implements Serializable, Cloneable
Contains information about an AWS Directory Service directory.
| Constructor and Description |
|---|
DirectoryDescription() |
| Modifier and Type | Method and Description |
|---|---|
DirectoryDescription |
clone() |
boolean |
equals(Object obj) |
String |
getAccessUrl()
The access URL for the directory, such as
http://. |
String |
getAlias()
The alias for the directory.
|
DirectoryConnectSettingsDescription |
getConnectSettings()
A DirectoryConnectSettingsDescription object that contains
additional information about an AD Connector directory.
|
String |
getDescription()
The textual description for the directory.
|
String |
getDirectoryId()
The directory identifier.
|
List<String> |
getDnsIpAddrs()
The IP addresses of the DNS servers for the directory.
|
Date |
getLaunchTime()
Specifies when the directory was created.
|
String |
getName()
The fully-qualified name of the directory.
|
RadiusSettings |
getRadiusSettings()
A RadiusSettings object that contains information about the
RADIUS server configured for this directory.
|
String |
getRadiusStatus()
The status of the RADIUS MFA server connection.
|
String |
getShortName()
The short name of the directory.
|
String |
getSize()
The directory size.
|
Boolean |
getSsoEnabled()
Indicates if single-sign on is enabled for the directory.
|
String |
getStage()
The current stage of the directory.
|
Date |
getStageLastUpdatedDateTime()
The date and time that the stage was last updated.
|
String |
getStageReason()
Additional information about the directory stage.
|
String |
getType()
The directory size.
|
DirectoryVpcSettingsDescription |
getVpcSettings()
A DirectoryVpcSettingsDescription object that contains
additional information about a Simple AD directory.
|
int |
hashCode() |
Boolean |
isSsoEnabled()
Indicates if single-sign on is enabled for the directory.
|
void |
setAccessUrl(String accessUrl)
The access URL for the directory, such as
http://. |
void |
setAlias(String alias)
The alias for the directory.
|
void |
setConnectSettings(DirectoryConnectSettingsDescription connectSettings)
A DirectoryConnectSettingsDescription object that contains
additional information about an AD Connector directory.
|
void |
setDescription(String description)
The textual description for the directory.
|
void |
setDirectoryId(String directoryId)
The directory identifier.
|
void |
setDnsIpAddrs(Collection<String> dnsIpAddrs)
The IP addresses of the DNS servers for the directory.
|
void |
setLaunchTime(Date launchTime)
Specifies when the directory was created.
|
void |
setName(String name)
The fully-qualified name of the directory.
|
void |
setRadiusSettings(RadiusSettings radiusSettings)
A RadiusSettings object that contains information about the
RADIUS server configured for this directory.
|
void |
setRadiusStatus(RadiusStatus radiusStatus)
The status of the RADIUS MFA server connection.
|
void |
setRadiusStatus(String radiusStatus)
The status of the RADIUS MFA server connection.
|
void |
setShortName(String shortName)
The short name of the directory.
|
void |
setSize(DirectorySize size)
The directory size.
|
void |
setSize(String size)
The directory size.
|
void |
setSsoEnabled(Boolean ssoEnabled)
Indicates if single-sign on is enabled for the directory.
|
void |
setStage(DirectoryStage stage)
The current stage of the directory.
|
void |
setStage(String stage)
The current stage of the directory.
|
void |
setStageLastUpdatedDateTime(Date stageLastUpdatedDateTime)
The date and time that the stage was last updated.
|
void |
setStageReason(String stageReason)
Additional information about the directory stage.
|
void |
setType(DirectoryType type)
The directory size.
|
void |
setType(String type)
The directory size.
|
void |
setVpcSettings(DirectoryVpcSettingsDescription vpcSettings)
A DirectoryVpcSettingsDescription object that contains
additional information about a Simple AD directory.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DirectoryDescription |
withAccessUrl(String accessUrl)
The access URL for the directory, such as
http://. |
DirectoryDescription |
withAlias(String alias)
The alias for the directory.
|
DirectoryDescription |
withConnectSettings(DirectoryConnectSettingsDescription connectSettings)
A DirectoryConnectSettingsDescription object that contains
additional information about an AD Connector directory.
|
DirectoryDescription |
withDescription(String description)
The textual description for the directory.
|
DirectoryDescription |
withDirectoryId(String directoryId)
The directory identifier.
|
DirectoryDescription |
withDnsIpAddrs(Collection<String> dnsIpAddrs)
The IP addresses of the DNS servers for the directory.
|
DirectoryDescription |
withDnsIpAddrs(String... dnsIpAddrs)
The IP addresses of the DNS servers for the directory.
|
DirectoryDescription |
withLaunchTime(Date launchTime)
Specifies when the directory was created.
|
DirectoryDescription |
withName(String name)
The fully-qualified name of the directory.
|
DirectoryDescription |
withRadiusSettings(RadiusSettings radiusSettings)
A RadiusSettings object that contains information about the
RADIUS server configured for this directory.
|
DirectoryDescription |
withRadiusStatus(RadiusStatus radiusStatus)
The status of the RADIUS MFA server connection.
|
DirectoryDescription |
withRadiusStatus(String radiusStatus)
The status of the RADIUS MFA server connection.
|
DirectoryDescription |
withShortName(String shortName)
The short name of the directory.
|
DirectoryDescription |
withSize(DirectorySize size)
The directory size.
|
DirectoryDescription |
withSize(String size)
The directory size.
|
DirectoryDescription |
withSsoEnabled(Boolean ssoEnabled)
Indicates if single-sign on is enabled for the directory.
|
DirectoryDescription |
withStage(DirectoryStage stage)
The current stage of the directory.
|
DirectoryDescription |
withStage(String stage)
The current stage of the directory.
|
DirectoryDescription |
withStageLastUpdatedDateTime(Date stageLastUpdatedDateTime)
The date and time that the stage was last updated.
|
DirectoryDescription |
withStageReason(String stageReason)
Additional information about the directory stage.
|
DirectoryDescription |
withType(DirectoryType type)
The directory size.
|
DirectoryDescription |
withType(String type)
The directory size.
|
DirectoryDescription |
withVpcSettings(DirectoryVpcSettingsDescription vpcSettings)
A DirectoryVpcSettingsDescription object that contains
additional information about a Simple AD directory.
|
public String getDirectoryId()
Constraints:
Pattern: ^d-[0-9a-f]{10}$
public void setDirectoryId(String directoryId)
Constraints:
Pattern: ^d-[0-9a-f]{10}$
directoryId - The directory identifier.public DirectoryDescription withDirectoryId(String directoryId)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Pattern: ^d-[0-9a-f]{10}$
directoryId - The directory identifier.public String getName()
Constraints:
Pattern: ^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$
public void setName(String name)
Constraints:
Pattern: ^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$
name - The fully-qualified name of the directory.public DirectoryDescription withName(String name)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Pattern: ^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$
name - The fully-qualified name of the directory.public String getShortName()
Constraints:
Pattern: ^[^\\/:*?\"\<\>|.]+[^\\/:*?\"<>|]*$
public void setShortName(String shortName)
Constraints:
Pattern: ^[^\\/:*?\"\<\>|.]+[^\\/:*?\"<>|]*$
shortName - The short name of the directory.public DirectoryDescription withShortName(String shortName)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Pattern: ^[^\\/:*?\"\<\>|.]+[^\\/:*?\"<>|]*$
shortName - The short name of the directory.public String getSize()
Constraints:
Allowed Values: Small, Large
DirectorySizepublic void setSize(String size)
Constraints:
Allowed Values: Small, Large
size - The directory size.DirectorySizepublic DirectoryDescription withSize(String size)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: Small, Large
size - The directory size.DirectorySizepublic void setSize(DirectorySize size)
Constraints:
Allowed Values: Small, Large
size - The directory size.DirectorySizepublic DirectoryDescription withSize(DirectorySize size)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: Small, Large
size - The directory size.DirectorySizepublic String getAlias()
Constraints:
Length: 1 - 62
Pattern: ^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*
public void setAlias(String alias)
Constraints:
Length: 1 - 62
Pattern: ^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*
alias - The alias for the directory.public DirectoryDescription withAlias(String alias)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 62
Pattern: ^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*
alias - The alias for the directory.public String getAccessUrl()
http://.awsapps.com .
Constraints:
Length: 1 - 128
http://.awsapps.com .public void setAccessUrl(String accessUrl)
http://.awsapps.com .
Constraints:
Length: 1 - 128
accessUrl - The access URL for the directory, such as
http://.awsapps.com .public DirectoryDescription withAccessUrl(String accessUrl)
http://.awsapps.com .
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
accessUrl - The access URL for the directory, such as
http://.awsapps.com .public String getDescription()
Constraints:
Length: 0 - 128
Pattern: ^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$
public void setDescription(String description)
Constraints:
Length: 0 - 128
Pattern: ^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$
description - The textual description for the directory.public DirectoryDescription withDescription(String description)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 128
Pattern: ^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$
description - The textual description for the directory.public List<String> getDnsIpAddrs()
public void setDnsIpAddrs(Collection<String> dnsIpAddrs)
dnsIpAddrs - The IP addresses of the DNS servers for the directory. For a Simple AD
directory, these are the IP addresses of the Simple 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
that the AD Connector is connected to.public DirectoryDescription withDnsIpAddrs(String... dnsIpAddrs)
NOTE: This method appends the values to the existing list (if
any). Use setDnsIpAddrs(java.util.Collection) or withDnsIpAddrs(java.util.Collection) if you want to override the
existing values.
Returns a reference to this object so that method calls can be chained together.
dnsIpAddrs - The IP addresses of the DNS servers for the directory. For a Simple AD
directory, these are the IP addresses of the Simple 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
that the AD Connector is connected to.public DirectoryDescription withDnsIpAddrs(Collection<String> dnsIpAddrs)
Returns a reference to this object so that method calls can be chained together.
dnsIpAddrs - The IP addresses of the DNS servers for the directory. For a Simple AD
directory, these are the IP addresses of the Simple 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
that the AD Connector is connected to.public String getStage()
Constraints:
Allowed Values: Requested, Creating, Created, Active, Inoperable, Impaired, Restoring, RestoreFailed, Deleting, Deleted, Failed
DirectoryStagepublic void setStage(String stage)
Constraints:
Allowed Values: Requested, Creating, Created, Active, Inoperable, Impaired, Restoring, RestoreFailed, Deleting, Deleted, Failed
stage - The current stage of the directory.DirectoryStagepublic DirectoryDescription withStage(String stage)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: Requested, Creating, Created, Active, Inoperable, Impaired, Restoring, RestoreFailed, Deleting, Deleted, Failed
stage - The current stage of the directory.DirectoryStagepublic void setStage(DirectoryStage stage)
Constraints:
Allowed Values: Requested, Creating, Created, Active, Inoperable, Impaired, Restoring, RestoreFailed, Deleting, Deleted, Failed
stage - The current stage of the directory.DirectoryStagepublic DirectoryDescription withStage(DirectoryStage stage)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: Requested, Creating, Created, Active, Inoperable, Impaired, Restoring, RestoreFailed, Deleting, Deleted, Failed
stage - The current stage of the directory.DirectoryStagepublic Date getLaunchTime()
public void setLaunchTime(Date launchTime)
launchTime - Specifies when the directory was created.public DirectoryDescription withLaunchTime(Date launchTime)
Returns a reference to this object so that method calls can be chained together.
launchTime - Specifies when the directory was created.public Date getStageLastUpdatedDateTime()
public void setStageLastUpdatedDateTime(Date stageLastUpdatedDateTime)
stageLastUpdatedDateTime - The date and time that the stage was last updated.public DirectoryDescription withStageLastUpdatedDateTime(Date stageLastUpdatedDateTime)
Returns a reference to this object so that method calls can be chained together.
stageLastUpdatedDateTime - The date and time that the stage was last updated.public String getType()
Constraints:
Allowed Values: SimpleAD, ADConnector
DirectoryTypepublic void setType(String type)
Constraints:
Allowed Values: SimpleAD, ADConnector
type - The directory size.DirectoryTypepublic DirectoryDescription withType(String type)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: SimpleAD, ADConnector
type - The directory size.DirectoryTypepublic void setType(DirectoryType type)
Constraints:
Allowed Values: SimpleAD, ADConnector
type - The directory size.DirectoryTypepublic DirectoryDescription withType(DirectoryType type)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: SimpleAD, ADConnector
type - The directory size.DirectoryTypepublic DirectoryVpcSettingsDescription getVpcSettings()
public void setVpcSettings(DirectoryVpcSettingsDescription vpcSettings)
vpcSettings - A DirectoryVpcSettingsDescription object that contains
additional information about a Simple AD directory. This member is
only present if the directory is a Simple AD directory.public DirectoryDescription withVpcSettings(DirectoryVpcSettingsDescription vpcSettings)
Returns a reference to this object so that method calls can be chained together.
vpcSettings - A DirectoryVpcSettingsDescription object that contains
additional information about a Simple AD directory. This member is
only present if the directory is a Simple AD directory.public DirectoryConnectSettingsDescription getConnectSettings()
public void setConnectSettings(DirectoryConnectSettingsDescription connectSettings)
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.public DirectoryDescription withConnectSettings(DirectoryConnectSettingsDescription connectSettings)
Returns a reference to this object so that method calls can be chained together.
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.public RadiusSettings getRadiusSettings()
public void setRadiusSettings(RadiusSettings radiusSettings)
radiusSettings - A RadiusSettings object that contains information about the
RADIUS server configured for this directory.public DirectoryDescription withRadiusSettings(RadiusSettings radiusSettings)
Returns a reference to this object so that method calls can be chained together.
radiusSettings - A RadiusSettings object that contains information about the
RADIUS server configured for this directory.public String getRadiusStatus()
Constraints:
Allowed Values: Creating, Completed, Failed
RadiusStatuspublic void setRadiusStatus(String radiusStatus)
Constraints:
Allowed Values: Creating, Completed, Failed
radiusStatus - The status of the RADIUS MFA server connection.RadiusStatuspublic DirectoryDescription withRadiusStatus(String radiusStatus)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: Creating, Completed, Failed
radiusStatus - The status of the RADIUS MFA server connection.RadiusStatuspublic void setRadiusStatus(RadiusStatus radiusStatus)
Constraints:
Allowed Values: Creating, Completed, Failed
radiusStatus - The status of the RADIUS MFA server connection.RadiusStatuspublic DirectoryDescription withRadiusStatus(RadiusStatus radiusStatus)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: Creating, Completed, Failed
radiusStatus - The status of the RADIUS MFA server connection.RadiusStatuspublic String getStageReason()
public void setStageReason(String stageReason)
stageReason - Additional information about the directory stage.public DirectoryDescription withStageReason(String stageReason)
Returns a reference to this object so that method calls can be chained together.
stageReason - Additional information about the directory stage.public Boolean isSsoEnabled()
public void setSsoEnabled(Boolean ssoEnabled)
ssoEnabled - Indicates if single-sign on is enabled for the directory. For more
information, see EnableSso and DisableSso.public DirectoryDescription withSsoEnabled(Boolean ssoEnabled)
Returns a reference to this object so that method calls can be chained together.
ssoEnabled - Indicates if single-sign on is enabled for the directory. For more
information, see EnableSso and DisableSso.public Boolean getSsoEnabled()
public String toString()
toString in class ObjectObject.toString()public DirectoryDescription clone()
Copyright © 2015. All rights reserved.