Class: Aws::DirectoryService::Types::DirectoryDescription

Inherits:

Struct

• Object
• Struct
• Aws::DirectoryService::Types::DirectoryDescription

Defined in:

gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb

Overview

Contains information about an Directory Service directory.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:share_notes]

Instance Attribute Summary

• #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

  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.

• #dns_ipv_6_addrs ⇒ Array<String>

  The IPv6 addresses of the DNS servers for the directory.

• #edition ⇒ String

  The edition associated with this directory.

• #hybrid_settings ⇒ Types::HybridSettingsDescription

  Contains information about the hybrid directory configuration for the directory, including Amazon Web Services System Manager managed node identifiers and DNS IPs.

• #launch_time ⇒ Time

  The date and time when the directory was created.

• #name ⇒ String

  The fully qualified name of the directory.

• #network_type ⇒ String

  The network type of the directory.

• #os_version ⇒ String

  The operating system (OS) version of the directory.

• #owner_directory_description ⇒ Types::OwnerDirectoryDescription

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

• #radius_settings ⇒ Types::RadiusSettings

  Information about the RadiusSettings object 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 Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services 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 Managed Microsoft AD directory.

• #short_name ⇒ String

  The short name of the directory.

• #size ⇒ String

  The directory size.

• #sso_enabled ⇒ Boolean

  Indicates whether 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 when the stage was last updated.

• #stage_reason ⇒ String

  Additional information about the directory stage.

• #type ⇒ String

  The directory type.

• #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 exists, <alias> is the directory identifier, such as d-XXXXXXXXXX.

Returns:

• (String)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#alias ⇒ String

The alias for the directory. If no alias exists, the alias is the directory identifier, such as d-XXXXXXXXXX.

Returns:

• (String)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#connect_settings ⇒ Types::DirectoryConnectSettingsDescription

DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory. Present only for AD Connector directories.

Returns:

• (Types::DirectoryConnectSettingsDescription)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#description ⇒ String

The description for the directory.

Returns:

• (String)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#desired_number_of_domain_controllers ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#directory_id ⇒ String

The directory identifier.

Returns:

• (String)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#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 self-managed directory to which the AD Connector is connected.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#dns_ipv_6_addrs ⇒ Array<String>

The IPv6 addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IPv6 addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IPv6 addresses of the DNS servers or domain controllers in your self-managed directory to which the AD Connector is connected.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#edition ⇒ String

The edition associated with this directory.

Returns:

• (String)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#hybrid_settings ⇒ Types::HybridSettingsDescription

Contains information about the hybrid directory configuration for the directory, including Amazon Web Services System Manager managed node identifiers and DNS IPs.

Returns:

• (Types::HybridSettingsDescription)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#launch_time ⇒ Time

The date and time when the directory was created.

Returns:

• (Time)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#name ⇒ String

The fully qualified name of the directory.

Returns:

• (String)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#network_type ⇒ String

The network type of the directory.

Returns:

• (String)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#os_version ⇒ String

The operating system (OS) version of the directory.

Returns:

• (String)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#owner_directory_description ⇒ Types::OwnerDirectoryDescription

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

Returns:

• (Types::OwnerDirectoryDescription)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#radius_settings ⇒ Types::RadiusSettings

Information about the RadiusSettings object configured for this directory.

Returns:

• (Types::RadiusSettings)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#radius_status ⇒ String

The status of the RADIUS MFA server connection.

Returns:

• (String)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#regions_info ⇒ Types::RegionsInfo

Lists the Regions where the directory has replicated.

Returns:

• (Types::RegionsInfo)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#share_method ⇒ String

The method used when sharing a directory to determine whether the directory should be shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account by sending a shared directory request (HANDSHAKE).

Returns:

• (String)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

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

Returns:

• (String)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#share_status ⇒ String

Current directory status of the shared Managed Microsoft AD directory.

Returns:

• (String)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#short_name ⇒ String

The short name of the directory.

Returns:

• (String)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#size ⇒ String

The directory size.

Returns:

• (String)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#sso_enabled ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#stage ⇒ String

The current stage of the directory.

Returns:

• (String)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#stage_last_updated_date_time ⇒ Time

The date and time when the stage was last updated.

Returns:

• (Time)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#stage_reason ⇒ String

Additional information about the directory stage.

Returns:

• (String)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#type ⇒ String

The directory type.

Returns:

• (String)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end

#vpc_settings ⇒ Types::DirectoryVpcSettingsDescription

A DirectoryVpcSettingsDescription object that contains additional information about a directory. Present only for Simple AD and Managed Microsoft AD directories.

Returns:

• (Types::DirectoryVpcSettingsDescription)

# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2711

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :edition,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :dns_ipv_6_addrs,
  :stage,
  :share_status,
  :share_method,
  :share_notes,
  :launch_time,
  :stage_last_updated_date_time,
  :type,
  :vpc_settings,
  :connect_settings,
  :radius_settings,
  :radius_status,
  :stage_reason,
  :sso_enabled,
  :desired_number_of_domain_controllers,
  :owner_directory_description,
  :regions_info,
  :os_version,
  :hybrid_settings,
  :network_type)
  SENSITIVE = [:share_notes]
  include Aws::Structure
end