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
show all
Defined in:
(unknown)

Overview

Contains information about an AWS Directory Service directory.

Instance Attribute Summary collapse

Instance Attribute Details

#access_urlString

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.

Returns:

  • (String)

    The access URL for the directory, such as http://<alias>.awsapps.com.

#aliasString

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:

  • (String)

    The alias for the directory.

#connect_settingsTypes::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.

Returns:

#descriptionString

The textual description for the directory.

Returns:

  • (String)

    The textual description for the directory.

#desired_number_of_domain_controllersInteger

The desired number of domain controllers in the directory if the directory is Microsoft AD.

Returns:

  • (Integer)

    The desired number of domain controllers in the directory if the directory is Microsoft AD.

#directory_idString

The directory identifier.

Returns:

  • (String)

    The directory identifier.

#dns_ip_addrsArray<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.

Returns:

  • (Array<String>)

    The IP addresses of the DNS servers for the directory.

#editionString

The edition associated with this directory.

Possible values:

  • Enterprise
  • Standard

Returns:

  • (String)

    The edition associated with this directory.

#launch_timeTime

Specifies when the directory was created.

Returns:

  • (Time)

    Specifies when the directory was created.

#nameString

The fully qualified name of the directory.

Returns:

  • (String)

    The fully qualified name of the directory.

#owner_directory_descriptionTypes::OwnerDirectoryDescription

Describes the AWS Managed Microsoft AD directory in the directory owner account.

Returns:

#radius_settingsTypes::RadiusSettings

A RadiusSettings object that contains information about the RADIUS server configured for this directory.

Returns:

#radius_statusString

The status of the RADIUS MFA server connection.

Possible values:

  • Creating
  • Completed
  • Failed

Returns:

  • (String)

    The status of the RADIUS MFA server connection.

#share_methodString

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

Returns:

  • (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_notesString

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.

Returns:

  • (String)

    A directory share request that is sent by the directory owner to the directory consumer.

#share_statusString

Current directory status of the shared AWS Managed Microsoft AD directory.

Possible values:

  • Shared
  • PendingAcceptance
  • Rejected
  • Rejecting
  • RejectFailed
  • Sharing
  • ShareFailed
  • Deleted
  • Deleting

Returns:

  • (String)

    Current directory status of the shared AWS Managed Microsoft AD directory.

#short_nameString

The short name of the directory.

Returns:

  • (String)

    The short name of the directory.

#sizeString

The directory size.

Possible values:

  • Small
  • Large

Returns:

  • (String)

    The directory size.

#sso_enabledBoolean

Indicates if single sign-on is enabled for the directory. For more information, see EnableSso and DisableSso.

Returns:

  • (Boolean)

    Indicates if single sign-on is enabled for the directory.

#stageString

The current stage of the directory.

Possible values:

  • Requested
  • Creating
  • Created
  • Active
  • Inoperable
  • Impaired
  • Restoring
  • RestoreFailed
  • Deleting
  • Deleted
  • Failed

Returns:

  • (String)

    The current stage of the directory.

#stage_last_updated_date_timeTime

The date and time that the stage was last updated.

Returns:

  • (Time)

    The date and time that the stage was last updated.

#stage_reasonString

Additional information about the directory stage.

Returns:

  • (String)

    Additional information about the directory stage.

#typeString

The directory size.

Possible values:

  • SimpleAD
  • ADConnector
  • MicrosoftAD
  • SharedMicrosoftAD

Returns:

  • (String)

    The directory size.

#vpc_settingsTypes::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.

Returns: