Class DirectoryDescription
- All Implemented Interfaces:
Serializable
,Cloneable
Contains information about an AWS Directory Service directory.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The access URL for the directory, such ashttp://
getAlias()
The alias for the directory.A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory.The textual description for the directory.The directory identifier.The IP addresses of the DNS servers for the directory.Specifies when the directory was created.getName()
The fully-qualified name of the directory.A RadiusSettings object that contains information about the RADIUS server configured for this directory.The status of the RADIUS MFA server connection.The short name of the directory.getSize()
The directory size.Indicates if single-sign on is enabled for the directory.getStage()
The current stage of the directory.The date and time that the stage was last updated.Additional information about the directory stage.getType()
The directory size.A DirectoryVpcSettingsDescription object that contains additional information about a directory.int
hashCode()
Indicates if single-sign on is enabled for the directory.void
setAccessUrl
(String accessUrl) The access URL for the directory, such ashttp://
void
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
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
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
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
The directory size.void
setVpcSettings
(DirectoryVpcSettingsDescription vpcSettings) A DirectoryVpcSettingsDescription object that contains additional information about a directory.toString()
Returns a string representation of this object; useful for testing and debugging.withAccessUrl
(String accessUrl) The access URL for the directory, such ashttp://
The alias for the directory.withConnectSettings
(DirectoryConnectSettingsDescription connectSettings) A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory.withDescription
(String description) The textual description for the directory.withDirectoryId
(String directoryId) The directory identifier.withDnsIpAddrs
(String... dnsIpAddrs) The IP addresses of the DNS servers for the directory.withDnsIpAddrs
(Collection<String> dnsIpAddrs) The IP addresses of the DNS servers for the directory.withLaunchTime
(Date launchTime) Specifies when the directory was created.The fully-qualified name of the directory.withRadiusSettings
(RadiusSettings radiusSettings) A RadiusSettings object that contains information about the RADIUS server configured for this directory.withRadiusStatus
(RadiusStatus radiusStatus) The status of the RADIUS MFA server connection.withRadiusStatus
(String radiusStatus) The status of the RADIUS MFA server connection.withShortName
(String shortName) The short name of the directory.withSize
(DirectorySize size) The directory size.The directory size.withSsoEnabled
(Boolean ssoEnabled) Indicates if single-sign on is enabled for the directory.withStage
(DirectoryStage stage) The current stage of the directory.The current stage of the directory.withStageLastUpdatedDateTime
(Date stageLastUpdatedDateTime) The date and time that the stage was last updated.withStageReason
(String stageReason) Additional information about the directory stage.withType
(DirectoryType type) The directory size.The directory size.withVpcSettings
(DirectoryVpcSettingsDescription vpcSettings) A DirectoryVpcSettingsDescription object that contains additional information about a directory.
-
Constructor Details
-
DirectoryDescription
public DirectoryDescription()
-
-
Method Details
-
setDirectoryId
The directory identifier.
- Parameters:
directoryId
- The directory identifier.
-
getDirectoryId
The directory identifier.
- Returns:
- The directory identifier.
-
withDirectoryId
The directory identifier.
- Parameters:
directoryId
- The directory identifier.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setName
The fully-qualified name of the directory.
- Parameters:
name
- The fully-qualified name of the directory.
-
getName
The fully-qualified name of the directory.
- Returns:
- The fully-qualified name of the directory.
-
withName
The fully-qualified name of the directory.
- Parameters:
name
- The fully-qualified name of the directory.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setShortName
The short name of the directory.
- Parameters:
shortName
- The short name of the directory.
-
getShortName
The short name of the directory.
- Returns:
- The short name of the directory.
-
withShortName
The short name of the directory.
- Parameters:
shortName
- The short name of the directory.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSize
The directory size.
- Parameters:
size
- The directory size.- See Also:
-
getSize
The directory size.
- Returns:
- The directory size.
- See Also:
-
withSize
The directory size.
- Parameters:
size
- The directory size.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setSize
The directory size.
- Parameters:
size
- The directory size.- See Also:
-
withSize
The directory size.
- Parameters:
size
- The directory size.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setAlias
The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as
d-XXXXXXXXXX
.- Parameters:
alias
- The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such asd-XXXXXXXXXX
.
-
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
.- 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
.
-
withAlias
The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as
d-XXXXXXXXXX
.- Parameters:
alias
- The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such asd-XXXXXXXXXX
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAccessUrl
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 asd-XXXXXXXXXX
.- Parameters:
accessUrl
- The access URL for the directory, such ashttp://alias.awsapps.com
. If no alias has been created for the directory,alias
is the directory identifier, such asd-XXXXXXXXXX
.
-
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 asd-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 asd-XXXXXXXXXX
.
-
withAccessUrl
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 asd-XXXXXXXXXX
.- Parameters:
accessUrl
- The access URL for the directory, such ashttp://alias.awsapps.com
. If no alias has been created for the directory,alias
is the directory identifier, such asd-XXXXXXXXXX
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDescription
The textual description for the directory.
- Parameters:
description
- The textual description for the directory.
-
getDescription
The textual description for the directory.
- Returns:
- The textual description for the directory.
-
withDescription
The textual description for the directory.
- Parameters:
description
- The textual description for the directory.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- 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.
-
setDnsIpAddrs
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.
- Parameters:
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.
-
withDnsIpAddrs
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)
orwithDnsIpAddrs(java.util.Collection)
if you want to override the existing values.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withDnsIpAddrs
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStage
The current stage of the directory.
- Parameters:
stage
- The current stage of the directory.- See Also:
-
getStage
The current stage of the directory.
- Returns:
- The current stage of the directory.
- See Also:
-
withStage
The current stage of the directory.
- Parameters:
stage
- The current stage of the directory.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setStage
The current stage of the directory.
- Parameters:
stage
- The current stage of the directory.- See Also:
-
withStage
The current stage of the directory.
- Parameters:
stage
- The current stage of the directory.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setLaunchTime
Specifies when the directory was created.
- Parameters:
launchTime
- Specifies when the directory was created.
-
getLaunchTime
Specifies when the directory was created.
- Returns:
- Specifies when the directory was created.
-
withLaunchTime
Specifies when the directory was created.
- Parameters:
launchTime
- Specifies when the directory was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStageLastUpdatedDateTime
The date and time that the stage was last updated.
- Parameters:
stageLastUpdatedDateTime
- The date and time that the stage was last updated.
-
getStageLastUpdatedDateTime
The date and time that the stage was last updated.
- Returns:
- The date and time that the stage was last updated.
-
withStageLastUpdatedDateTime
The date and time that the stage was last updated.
- Parameters:
stageLastUpdatedDateTime
- The date and time that the stage was last updated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setType
The directory size.
- Parameters:
type
- The directory size.- See Also:
-
getType
The directory size.
- Returns:
- The directory size.
- See Also:
-
withType
The directory size.
- Parameters:
type
- The directory size.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setType
The directory size.
- Parameters:
type
- The directory size.- See Also:
-
withType
The directory size.
- Parameters:
type
- The directory size.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setVpcSettings
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.
- Parameters:
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.
-
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.
- 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.
-
withVpcSettings
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
setConnectSettings
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.
- Parameters:
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.
-
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.
- 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.
-
withConnectSettings
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
setRadiusSettings
A RadiusSettings object that contains information about the RADIUS server configured for this directory.
- Parameters:
radiusSettings
- A RadiusSettings object that contains information about the RADIUS server configured for this directory.
-
getRadiusSettings
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.
-
withRadiusSettings
A RadiusSettings object that contains information about the RADIUS server configured for this directory.
- Parameters:
radiusSettings
- A RadiusSettings object that contains information about the RADIUS server configured for this directory.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setRadiusStatus
The status of the RADIUS MFA server connection.
- Parameters:
radiusStatus
- The status of the RADIUS MFA server connection.- See Also:
-
getRadiusStatus
The status of the RADIUS MFA server connection.
- Returns:
- The status of the RADIUS MFA server connection.
- See Also:
-
withRadiusStatus
The status of the RADIUS MFA server connection.
- Parameters:
radiusStatus
- The status of the RADIUS MFA server connection.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setRadiusStatus
The status of the RADIUS MFA server connection.
- Parameters:
radiusStatus
- The status of the RADIUS MFA server connection.- See Also:
-
withRadiusStatus
The status of the RADIUS MFA server connection.
- Parameters:
radiusStatus
- The status of the RADIUS MFA server connection.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setStageReason
Additional information about the directory stage.
- Parameters:
stageReason
- Additional information about the directory stage.
-
getStageReason
Additional information about the directory stage.
- Returns:
- Additional information about the directory stage.
-
withStageReason
Additional information about the directory stage.
- Parameters:
stageReason
- Additional information about the directory stage.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSsoEnabled
Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.
- Parameters:
ssoEnabled
- Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.
-
getSsoEnabled
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.
-
withSsoEnabled
Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.
- Parameters:
ssoEnabled
- Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isSsoEnabled
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.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-