public class DirectoryDescription
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Contains information about an AWS Directory Service directory.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
accessUrl
The access URL for the directory, such as
http://alias.awsapps.com
. |
private java.lang.String |
alias
The alias for the directory.
|
private DirectoryConnectSettingsDescription |
connectSettings
A DirectoryConnectSettingsDescription object that contains
additional information about an AD Connector directory.
|
private java.lang.String |
description
The textual description for the directory.
|
private java.lang.String |
directoryId
The directory identifier.
|
private SdkInternalList<java.lang.String> |
dnsIpAddrs
The IP addresses of the DNS servers for the directory.
|
private java.util.Date |
launchTime
Specifies when the directory was created.
|
private java.lang.String |
name
The fully-qualified name of the directory.
|
private RadiusSettings |
radiusSettings
A RadiusSettings object that contains information about the RADIUS
server configured for this directory.
|
private java.lang.String |
radiusStatus
The status of the RADIUS MFA server connection.
|
private java.lang.String |
shortName
The short name of the directory.
|
private java.lang.String |
size
The directory size.
|
private java.lang.Boolean |
ssoEnabled
Indicates if single-sign on is enabled for the directory.
|
private java.lang.String |
stage
The current stage of the directory.
|
private java.util.Date |
stageLastUpdatedDateTime
The date and time that the stage was last updated.
|
private java.lang.String |
stageReason
Additional information about the directory stage.
|
private java.lang.String |
type
The directory size.
|
private DirectoryVpcSettingsDescription |
vpcSettings
A DirectoryVpcSettingsDescription object that contains additional
information about a directory.
|
Constructor and Description |
---|
DirectoryDescription() |
Modifier and Type | Method and Description |
---|---|
DirectoryDescription |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getAccessUrl()
The access URL for the directory, such as
http://alias.awsapps.com
. |
java.lang.String |
getAlias()
The alias for the directory.
|
DirectoryConnectSettingsDescription |
getConnectSettings()
A DirectoryConnectSettingsDescription object that contains
additional information about an AD Connector directory.
|
java.lang.String |
getDescription()
The textual description for the directory.
|
java.lang.String |
getDirectoryId()
The directory identifier.
|
java.util.List<java.lang.String> |
getDnsIpAddrs()
The IP addresses of the DNS servers for the directory.
|
java.util.Date |
getLaunchTime()
Specifies when the directory was created.
|
java.lang.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.
|
java.lang.String |
getRadiusStatus()
The status of the RADIUS MFA server connection.
|
java.lang.String |
getShortName()
The short name of the directory.
|
java.lang.String |
getSize()
The directory size.
|
java.lang.Boolean |
getSsoEnabled()
Indicates if single-sign on is enabled for the directory.
|
java.lang.String |
getStage()
The current stage of the directory.
|
java.util.Date |
getStageLastUpdatedDateTime()
The date and time that the stage was last updated.
|
java.lang.String |
getStageReason()
Additional information about the directory stage.
|
java.lang.String |
getType()
The directory size.
|
DirectoryVpcSettingsDescription |
getVpcSettings()
A DirectoryVpcSettingsDescription object that contains additional
information about a directory.
|
int |
hashCode() |
java.lang.Boolean |
isSsoEnabled()
Indicates if single-sign on is enabled for the directory.
|
void |
setAccessUrl(java.lang.String accessUrl)
The access URL for the directory, such as
http://alias.awsapps.com
. |
void |
setAlias(java.lang.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(java.lang.String description)
The textual description for the directory.
|
void |
setDirectoryId(java.lang.String directoryId)
The directory identifier.
|
void |
setDnsIpAddrs(java.util.Collection<java.lang.String> dnsIpAddrs)
The IP addresses of the DNS servers for the directory.
|
void |
setLaunchTime(java.util.Date launchTime)
Specifies when the directory was created.
|
void |
setName(java.lang.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(java.lang.String radiusStatus)
The status of the RADIUS MFA server connection.
|
void |
setShortName(java.lang.String shortName)
The short name of the directory.
|
void |
setSize(DirectorySize size)
The directory size.
|
void |
setSize(java.lang.String size)
The directory size.
|
void |
setSsoEnabled(java.lang.Boolean ssoEnabled)
Indicates if single-sign on is enabled for the directory.
|
void |
setStage(DirectoryStage stage)
The current stage of the directory.
|
void |
setStage(java.lang.String stage)
The current stage of the directory.
|
void |
setStageLastUpdatedDateTime(java.util.Date stageLastUpdatedDateTime)
The date and time that the stage was last updated.
|
void |
setStageReason(java.lang.String stageReason)
Additional information about the directory stage.
|
void |
setType(DirectoryType type)
The directory size.
|
void |
setType(java.lang.String type)
The directory size.
|
void |
setVpcSettings(DirectoryVpcSettingsDescription vpcSettings)
A DirectoryVpcSettingsDescription object that contains additional
information about a directory.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DirectoryDescription |
withAccessUrl(java.lang.String accessUrl)
The access URL for the directory, such as
http://alias.awsapps.com
. |
DirectoryDescription |
withAlias(java.lang.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(java.lang.String description)
The textual description for the directory.
|
DirectoryDescription |
withDirectoryId(java.lang.String directoryId)
The directory identifier.
|
DirectoryDescription |
withDnsIpAddrs(java.util.Collection<java.lang.String> dnsIpAddrs)
The IP addresses of the DNS servers for the directory.
|
DirectoryDescription |
withDnsIpAddrs(java.lang.String... dnsIpAddrs)
The IP addresses of the DNS servers for the directory.
|
DirectoryDescription |
withLaunchTime(java.util.Date launchTime)
Specifies when the directory was created.
|
DirectoryDescription |
withName(java.lang.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(java.lang.String radiusStatus)
The status of the RADIUS MFA server connection.
|
DirectoryDescription |
withShortName(java.lang.String shortName)
The short name of the directory.
|
DirectoryDescription |
withSize(DirectorySize size)
The directory size.
|
DirectoryDescription |
withSize(java.lang.String size)
The directory size.
|
DirectoryDescription |
withSsoEnabled(java.lang.Boolean ssoEnabled)
Indicates if single-sign on is enabled for the directory.
|
DirectoryDescription |
withStage(DirectoryStage stage)
The current stage of the directory.
|
DirectoryDescription |
withStage(java.lang.String stage)
The current stage of the directory.
|
DirectoryDescription |
withStageLastUpdatedDateTime(java.util.Date stageLastUpdatedDateTime)
The date and time that the stage was last updated.
|
DirectoryDescription |
withStageReason(java.lang.String stageReason)
Additional information about the directory stage.
|
DirectoryDescription |
withType(DirectoryType type)
The directory size.
|
DirectoryDescription |
withType(java.lang.String type)
The directory size.
|
DirectoryDescription |
withVpcSettings(DirectoryVpcSettingsDescription vpcSettings)
A DirectoryVpcSettingsDescription object that contains additional
information about a directory.
|
private java.lang.String directoryId
The directory identifier.
private java.lang.String name
The fully-qualified name of the directory.
private java.lang.String shortName
The short name of the directory.
private java.lang.String size
The directory size.
private java.lang.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
.
private java.lang.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
.
private java.lang.String description
The textual description for the directory.
private SdkInternalList<java.lang.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.
private java.lang.String stage
The current stage of the directory.
private java.util.Date launchTime
Specifies when the directory was created.
private java.util.Date stageLastUpdatedDateTime
The date and time that the stage was last updated.
private java.lang.String type
The directory size.
private 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.
private 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.
private RadiusSettings radiusSettings
A RadiusSettings object that contains information about the RADIUS server configured for this directory.
private java.lang.String radiusStatus
The status of the RADIUS MFA server connection.
private java.lang.String stageReason
Additional information about the directory stage.
private java.lang.Boolean ssoEnabled
Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.
public void setDirectoryId(java.lang.String directoryId)
The directory identifier.
directoryId
- The directory identifier.public java.lang.String getDirectoryId()
The directory identifier.
public DirectoryDescription withDirectoryId(java.lang.String directoryId)
The directory identifier.
directoryId
- The directory identifier.public void setName(java.lang.String name)
The fully-qualified name of the directory.
name
- The fully-qualified name of the directory.public java.lang.String getName()
The fully-qualified name of the directory.
public DirectoryDescription withName(java.lang.String name)
The fully-qualified name of the directory.
name
- The fully-qualified name of the directory.public void setShortName(java.lang.String shortName)
The short name of the directory.
shortName
- The short name of the directory.public java.lang.String getShortName()
The short name of the directory.
public DirectoryDescription withShortName(java.lang.String shortName)
The short name of the directory.
shortName
- The short name of the directory.public void setSize(java.lang.String size)
The directory size.
size
- The directory size.DirectorySize
public java.lang.String getSize()
The directory size.
DirectorySize
public DirectoryDescription withSize(java.lang.String size)
The directory size.
size
- The directory size.DirectorySize
public void setSize(DirectorySize size)
The directory size.
size
- The directory size.DirectorySize
public DirectoryDescription withSize(DirectorySize size)
The directory size.
size
- The directory size.DirectorySize
public void setAlias(java.lang.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
.
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
.public java.lang.String getAlias()
The alias for the directory. If no alias has been created for the
directory, the alias is the directory identifier, such as
d-XXXXXXXXXX
.
d-XXXXXXXXXX
.public DirectoryDescription withAlias(java.lang.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
.
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
.public void setAccessUrl(java.lang.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
.
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
.public java.lang.String getAccessUrl()
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
.
http://alias.awsapps.com
. If no alias has been created for the directory,
alias
is the
directory identifier, such as d-XXXXXXXXXX
.public DirectoryDescription withAccessUrl(java.lang.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
.
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
.public void setDescription(java.lang.String description)
The textual description for the directory.
description
- The textual description for the directory.public java.lang.String getDescription()
The textual description for the directory.
public DirectoryDescription withDescription(java.lang.String description)
The textual description for the directory.
description
- The textual description for the directory.public java.util.List<java.lang.String> getDnsIpAddrs()
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.
public void setDnsIpAddrs(java.util.Collection<java.lang.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.
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.public DirectoryDescription withDnsIpAddrs(java.lang.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.
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.
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.public DirectoryDescription withDnsIpAddrs(java.util.Collection<java.lang.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.
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.public void setStage(java.lang.String stage)
The current stage of the directory.
stage
- The current stage of the directory.DirectoryStage
public java.lang.String getStage()
The current stage of the directory.
DirectoryStage
public DirectoryDescription withStage(java.lang.String stage)
The current stage of the directory.
stage
- The current stage of the directory.DirectoryStage
public void setStage(DirectoryStage stage)
The current stage of the directory.
stage
- The current stage of the directory.DirectoryStage
public DirectoryDescription withStage(DirectoryStage stage)
The current stage of the directory.
stage
- The current stage of the directory.DirectoryStage
public void setLaunchTime(java.util.Date launchTime)
Specifies when the directory was created.
launchTime
- Specifies when the directory was created.public java.util.Date getLaunchTime()
Specifies when the directory was created.
public DirectoryDescription withLaunchTime(java.util.Date launchTime)
Specifies when the directory was created.
launchTime
- Specifies when the directory was created.public void setStageLastUpdatedDateTime(java.util.Date stageLastUpdatedDateTime)
The date and time that the stage was last updated.
stageLastUpdatedDateTime
- The date and time that the stage was last updated.public java.util.Date getStageLastUpdatedDateTime()
The date and time that the stage was last updated.
public DirectoryDescription withStageLastUpdatedDateTime(java.util.Date stageLastUpdatedDateTime)
The date and time that the stage was last updated.
stageLastUpdatedDateTime
- The date and time that the stage was last updated.public void setType(java.lang.String type)
The directory size.
type
- The directory size.DirectoryType
public java.lang.String getType()
The directory size.
DirectoryType
public DirectoryDescription withType(java.lang.String type)
The directory size.
type
- The directory size.DirectoryType
public void setType(DirectoryType type)
The directory size.
type
- The directory size.DirectoryType
public DirectoryDescription withType(DirectoryType type)
The directory size.
type
- The directory size.DirectoryType
public void setVpcSettings(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.
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.public DirectoryVpcSettingsDescription getVpcSettings()
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.
public DirectoryDescription withVpcSettings(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.
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.public void setConnectSettings(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.
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 DirectoryConnectSettingsDescription getConnectSettings()
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)
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.
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 void setRadiusSettings(RadiusSettings radiusSettings)
A RadiusSettings object that contains information about the RADIUS server configured for this directory.
radiusSettings
- A RadiusSettings object that contains information about the
RADIUS server configured for this directory.public RadiusSettings getRadiusSettings()
A RadiusSettings object that contains information about the RADIUS server configured for this directory.
public DirectoryDescription withRadiusSettings(RadiusSettings radiusSettings)
A RadiusSettings object that contains information about the RADIUS server configured for this directory.
radiusSettings
- A RadiusSettings object that contains information about the
RADIUS server configured for this directory.public void setRadiusStatus(java.lang.String radiusStatus)
The status of the RADIUS MFA server connection.
radiusStatus
- The status of the RADIUS MFA server connection.RadiusStatus
public java.lang.String getRadiusStatus()
The status of the RADIUS MFA server connection.
RadiusStatus
public DirectoryDescription withRadiusStatus(java.lang.String radiusStatus)
The status of the RADIUS MFA server connection.
radiusStatus
- The status of the RADIUS MFA server connection.RadiusStatus
public void setRadiusStatus(RadiusStatus radiusStatus)
The status of the RADIUS MFA server connection.
radiusStatus
- The status of the RADIUS MFA server connection.RadiusStatus
public DirectoryDescription withRadiusStatus(RadiusStatus radiusStatus)
The status of the RADIUS MFA server connection.
radiusStatus
- The status of the RADIUS MFA server connection.RadiusStatus
public void setStageReason(java.lang.String stageReason)
Additional information about the directory stage.
stageReason
- Additional information about the directory stage.public java.lang.String getStageReason()
Additional information about the directory stage.
public DirectoryDescription withStageReason(java.lang.String stageReason)
Additional information about the directory stage.
stageReason
- Additional information about the directory stage.public void setSsoEnabled(java.lang.Boolean ssoEnabled)
Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.
ssoEnabled
- Indicates if single-sign on is enabled for the directory. For more
information, see EnableSso and DisableSso.public java.lang.Boolean getSsoEnabled()
Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.
public DirectoryDescription withSsoEnabled(java.lang.Boolean ssoEnabled)
Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.
ssoEnabled
- Indicates if single-sign on is enabled for the directory. For more
information, see EnableSso and DisableSso.public java.lang.Boolean isSsoEnabled()
Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public DirectoryDescription clone()
clone
in class java.lang.Object