@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DirectoryDescription extends Object implements Serializable, Cloneable, StructuredPojo
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://<alias>.awsapps.com . |
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.
|
Integer |
getDesiredNumberOfDomainControllers()
The desired number of domain controllers in the directory if the directory is Microsoft AD.
|
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 directory.
|
int |
hashCode() |
Boolean |
isSsoEnabled()
Indicates if single-sign on is enabled for the directory.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAccessUrl(String accessUrl)
The access URL for the directory, such as
http://<alias>.awsapps.com . |
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 |
setDesiredNumberOfDomainControllers(Integer desiredNumberOfDomainControllers)
The desired number of domain controllers in the directory if the directory is Microsoft AD.
|
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 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://<alias>.awsapps.com . |
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 |
withDesiredNumberOfDomainControllers(Integer desiredNumberOfDomainControllers)
The desired number of domain controllers in the directory if the directory is Microsoft AD.
|
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 directory.
|
public void setDirectoryId(String directoryId)
The directory identifier.
directoryId
- The directory identifier.public String getDirectoryId()
The directory identifier.
public DirectoryDescription withDirectoryId(String directoryId)
The directory identifier.
directoryId
- The directory identifier.public void setName(String name)
The fully-qualified name of the directory.
name
- The fully-qualified name of the directory.public String getName()
The fully-qualified name of the directory.
public DirectoryDescription withName(String name)
The fully-qualified name of the directory.
name
- The fully-qualified name of the directory.public void setShortName(String shortName)
The short name of the directory.
shortName
- The short name of the directory.public String getShortName()
The short name of the directory.
public DirectoryDescription withShortName(String shortName)
The short name of the directory.
shortName
- The short name of the directory.public void setSize(String size)
The directory size.
size
- The directory size.DirectorySize
public String getSize()
The directory size.
DirectorySize
public DirectoryDescription withSize(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(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 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(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(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 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(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(String description)
The textual description for the directory.
description
- The textual description for the directory.public String getDescription()
The textual description for the directory.
public DirectoryDescription withDescription(String description)
The textual description for the directory.
description
- The textual description for the directory.public List<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(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 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(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(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 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(String stage)
The current stage of the directory.
stage
- The current stage of the directory.DirectoryStage
public String getStage()
The current stage of the directory.
DirectoryStage
public DirectoryDescription withStage(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(Date launchTime)
Specifies when the directory was created.
launchTime
- Specifies when the directory was created.public Date getLaunchTime()
Specifies when the directory was created.
public DirectoryDescription withLaunchTime(Date launchTime)
Specifies when the directory was created.
launchTime
- Specifies when the directory was created.public void setStageLastUpdatedDateTime(Date stageLastUpdatedDateTime)
The date and time that the stage was last updated.
stageLastUpdatedDateTime
- The date and time that the stage was last updated.public Date getStageLastUpdatedDateTime()
The date and time that the stage was last updated.
public DirectoryDescription withStageLastUpdatedDateTime(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(String type)
The directory size.
type
- The directory size.DirectoryType
public String getType()
The directory size.
DirectoryType
public DirectoryDescription withType(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(String radiusStatus)
The status of the RADIUS MFA server connection.
radiusStatus
- The status of the RADIUS MFA server connection.RadiusStatus
public String getRadiusStatus()
The status of the RADIUS MFA server connection.
RadiusStatus
public DirectoryDescription withRadiusStatus(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(String stageReason)
Additional information about the directory stage.
stageReason
- Additional information about the directory stage.public String getStageReason()
Additional information about the directory stage.
public DirectoryDescription withStageReason(String stageReason)
Additional information about the directory stage.
stageReason
- Additional information about the directory stage.public void setSsoEnabled(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 Boolean getSsoEnabled()
Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.
public DirectoryDescription withSsoEnabled(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 Boolean isSsoEnabled()
Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.
public void setDesiredNumberOfDomainControllers(Integer desiredNumberOfDomainControllers)
The desired number of domain controllers in the directory if the directory is Microsoft AD.
desiredNumberOfDomainControllers
- The desired number of domain controllers in the directory if the directory is Microsoft AD.public Integer getDesiredNumberOfDomainControllers()
The desired number of domain controllers in the directory if the directory is Microsoft AD.
public DirectoryDescription withDesiredNumberOfDomainControllers(Integer desiredNumberOfDomainControllers)
The desired number of domain controllers in the directory if the directory is Microsoft AD.
desiredNumberOfDomainControllers
- The desired number of domain controllers in the directory if the directory is Microsoft AD.public String toString()
toString
in class Object
Object.toString()
public DirectoryDescription clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.