You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::DirectoryService::Types::DirectoryDescription
- Inherits:
-
Struct
- Object
- Struct
- Aws::DirectoryService::Types::DirectoryDescription
- Defined in:
- (unknown)
Overview
Contains information about an AWS Directory Service directory.
Instance Attribute Summary collapse
-
#access_url ⇒ String
The access URL for the directory, such as
http://<alias>.awsapps.com
. -
#alias ⇒ String
The alias for the directory.
-
#connect_settings ⇒ Types::DirectoryConnectSettingsDescription
A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory.
-
#description ⇒ String
The description for the directory.
-
#desired_number_of_domain_controllers ⇒ Integer
The desired number of domain controllers in the directory if the directory is Microsoft AD.
-
#directory_id ⇒ String
The directory identifier.
-
#dns_ip_addrs ⇒ Array<String>
The IP addresses of the DNS servers for the directory.
-
#edition ⇒ String
The edition associated with this directory.
-
#launch_time ⇒ Time
Specifies when the directory was created.
-
#name ⇒ String
The fully qualified name of the directory.
-
#owner_directory_description ⇒ Types::OwnerDirectoryDescription
Describes the AWS Managed Microsoft AD directory in the directory owner account.
-
#radius_settings ⇒ Types::RadiusSettings
A RadiusSettings object that contains information about the RADIUS server configured for this directory.
-
#radius_status ⇒ String
The status of the RADIUS MFA server connection.
-
#regions_info ⇒ Types::RegionsInfo
Lists the Regions where the directory has replicated.
-
#share_method ⇒ String
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
). -
#share_notes ⇒ String
A directory share request that is sent by the directory owner to the directory consumer.
-
#share_status ⇒ String
Current directory status of the shared AWS Managed Microsoft AD directory.
-
#short_name ⇒ String
The short name of the directory.
-
#size ⇒ String
The directory size.
-
#sso_enabled ⇒ Boolean
Indicates if single sign-on is enabled for the directory.
-
#stage ⇒ String
The current stage of the directory.
-
#stage_last_updated_date_time ⇒ Time
The date and time that the stage was last updated.
-
#stage_reason ⇒ String
Additional information about the directory stage.
-
#type ⇒ String
The directory size.
-
#vpc_settings ⇒ Types::DirectoryVpcSettingsDescription
A DirectoryVpcSettingsDescription object that contains additional information about a directory.
Instance Attribute Details
#access_url ⇒ String
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
.
#alias ⇒ String
The alias for the directory. If no alias has been created for the
directory, the alias is the directory identifier, such as
d-XXXXXXXXXX
.
#connect_settings ⇒ Types::DirectoryConnectSettingsDescription
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.
#description ⇒ String
The description for the directory.
#desired_number_of_domain_controllers ⇒ Integer
The desired number of domain controllers in the directory if the directory is Microsoft AD.
#directory_id ⇒ String
The directory identifier.
#dns_ip_addrs ⇒ Array<String>
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.
#edition ⇒ String
The edition associated with this directory.
Possible values:
- Enterprise
- Standard
#launch_time ⇒ Time
Specifies when the directory was created.
#name ⇒ String
The fully qualified name of the directory.
#owner_directory_description ⇒ Types::OwnerDirectoryDescription
Describes the AWS Managed Microsoft AD directory in the directory owner account.
#radius_settings ⇒ Types::RadiusSettings
A RadiusSettings object that contains information about the RADIUS server configured for this directory.
#radius_status ⇒ String
The status of the RADIUS MFA server connection.
Possible values:
- Creating
- Completed
- Failed
#regions_info ⇒ Types::RegionsInfo
Lists the Regions where the directory has replicated.
#share_method ⇒ String
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
).
Possible values:
- ORGANIZATIONS
- HANDSHAKE
#share_notes ⇒ String
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.
#share_status ⇒ String
Current directory status of the shared AWS Managed Microsoft AD directory.
Possible values:
- Shared
- PendingAcceptance
- Rejected
- Rejecting
- RejectFailed
- Sharing
- ShareFailed
- Deleted
- Deleting
#short_name ⇒ String
The short name of the directory.
#size ⇒ String
The directory size.
Possible values:
- Small
- Large
#sso_enabled ⇒ Boolean
Indicates if single sign-on is enabled for the directory. For more information, see EnableSso and DisableSso.
#stage ⇒ String
The current stage of the directory.
Possible values:
- Requested
- Creating
- Created
- Active
- Inoperable
- Impaired
- Restoring
- RestoreFailed
- Deleting
- Deleted
- Failed
#stage_last_updated_date_time ⇒ Time
The date and time that the stage was last updated.
#stage_reason ⇒ String
Additional information about the directory stage.
#type ⇒ String
The directory size.
Possible values:
- SimpleAD
- ADConnector
- MicrosoftAD
- SharedMicrosoftAD
#vpc_settings ⇒ Types::DirectoryVpcSettingsDescription
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.