You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb

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)


1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1446

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :stage,
  :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)
  include Aws::Structure
end

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


1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1446

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :stage,
  :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)
  include Aws::Structure
end

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



1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1446

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :stage,
  :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)
  include Aws::Structure
end

#descriptionString

The textual description for the directory.

Returns:

  • (String)


1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1446

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :stage,
  :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)
  include Aws::Structure
end

#desired_number_of_domain_controllersInteger

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

Returns:

  • (Integer)


1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1446

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :stage,
  :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)
  include Aws::Structure
end

#directory_idString

The directory identifier.

Returns:

  • (String)


1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1446

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :stage,
  :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)
  include Aws::Structure
end

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


1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1446

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :stage,
  :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)
  include Aws::Structure
end

#launch_timeTime

Specifies when the directory was created.

Returns:

  • (Time)


1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1446

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :stage,
  :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)
  include Aws::Structure
end

#nameString

The fully-qualified name of the directory.

Returns:

  • (String)


1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1446

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :stage,
  :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)
  include Aws::Structure
end

#radius_settingsTypes::RadiusSettings

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



1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1446

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :stage,
  :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)
  include Aws::Structure
end

#radius_statusString

The status of the RADIUS MFA server connection.

Returns:

  • (String)


1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1446

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :stage,
  :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)
  include Aws::Structure
end

#short_nameString

The short name of the directory.

Returns:

  • (String)


1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1446

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :stage,
  :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)
  include Aws::Structure
end

#sizeString

The directory size.

Returns:

  • (String)


1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1446

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :stage,
  :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)
  include Aws::Structure
end

#sso_enabledBoolean

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

Returns:

  • (Boolean)


1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1446

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :stage,
  :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)
  include Aws::Structure
end

#stageString

The current stage of the directory.

Returns:

  • (String)


1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1446

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :stage,
  :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)
  include Aws::Structure
end

#stage_last_updated_date_timeTime

The date and time that the stage was last updated.

Returns:

  • (Time)


1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1446

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :stage,
  :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)
  include Aws::Structure
end

#stage_reasonString

Additional information about the directory stage.

Returns:

  • (String)


1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1446

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :stage,
  :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)
  include Aws::Structure
end

#typeString

The directory size.

Returns:

  • (String)


1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1446

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :stage,
  :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)
  include Aws::Structure
end

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



1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 1446

class DirectoryDescription < Struct.new(
  :directory_id,
  :name,
  :short_name,
  :size,
  :alias,
  :access_url,
  :description,
  :dns_ip_addrs,
  :stage,
  :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)
  include Aws::Structure
end