Class: Aws::DirectoryService::Types::RadiusSettings

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

Overview

Note:

When making an API call, you may pass RadiusSettings data as a hash:

{
  radius_servers: ["Server"],
  radius_port: 1,
  radius_timeout: 1,
  radius_retries: 1,
  shared_secret: "RadiusSharedSecret",
  authentication_protocol: "PAP", # accepts PAP, CHAP, MS-CHAPv1, MS-CHAPv2
  display_label: "RadiusDisplayLabel",
  use_same_username: false,
}

Contains information about a Remote Authentication Dial In User Service (RADIUS) server.

Constant Summary collapse

SENSITIVE =
[:shared_secret]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_protocolString

The protocol specified for your RADIUS endpoints.

Returns:

  • (String)


3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 3866

class RadiusSettings < Struct.new(
  :radius_servers,
  :radius_port,
  :radius_timeout,
  :radius_retries,
  :shared_secret,
  :authentication_protocol,
  :display_label,
  :use_same_username)
  SENSITIVE = [:shared_secret]
  include Aws::Structure
end

#display_labelString

Not currently used.

Returns:

  • (String)


3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 3866

class RadiusSettings < Struct.new(
  :radius_servers,
  :radius_port,
  :radius_timeout,
  :radius_retries,
  :shared_secret,
  :authentication_protocol,
  :display_label,
  :use_same_username)
  SENSITIVE = [:shared_secret]
  include Aws::Structure
end

#radius_portInteger

The port that your RADIUS server is using for communications. Your self-managed network must allow inbound traffic over this port from the Directory Service servers.

Returns:

  • (Integer)


3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 3866

class RadiusSettings < Struct.new(
  :radius_servers,
  :radius_port,
  :radius_timeout,
  :radius_retries,
  :shared_secret,
  :authentication_protocol,
  :display_label,
  :use_same_username)
  SENSITIVE = [:shared_secret]
  include Aws::Structure
end

#radius_retriesInteger

The maximum number of times that communication with the RADIUS server is attempted.

Returns:

  • (Integer)


3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 3866

class RadiusSettings < Struct.new(
  :radius_servers,
  :radius_port,
  :radius_timeout,
  :radius_retries,
  :shared_secret,
  :authentication_protocol,
  :display_label,
  :use_same_username)
  SENSITIVE = [:shared_secret]
  include Aws::Structure
end

#radius_serversArray<String>

An array of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.

Returns:

  • (Array<String>)


3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 3866

class RadiusSettings < Struct.new(
  :radius_servers,
  :radius_port,
  :radius_timeout,
  :radius_retries,
  :shared_secret,
  :authentication_protocol,
  :display_label,
  :use_same_username)
  SENSITIVE = [:shared_secret]
  include Aws::Structure
end

#radius_timeoutInteger

The amount of time, in seconds, to wait for the RADIUS server to respond.

Returns:

  • (Integer)


3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 3866

class RadiusSettings < Struct.new(
  :radius_servers,
  :radius_port,
  :radius_timeout,
  :radius_retries,
  :shared_secret,
  :authentication_protocol,
  :display_label,
  :use_same_username)
  SENSITIVE = [:shared_secret]
  include Aws::Structure
end

#shared_secretString

Required for enabling RADIUS on the directory.

Returns:

  • (String)


3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 3866

class RadiusSettings < Struct.new(
  :radius_servers,
  :radius_port,
  :radius_timeout,
  :radius_retries,
  :shared_secret,
  :authentication_protocol,
  :display_label,
  :use_same_username)
  SENSITIVE = [:shared_secret]
  include Aws::Structure
end

#use_same_usernameBoolean

Not currently used.

Returns:

  • (Boolean)


3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 3866

class RadiusSettings < Struct.new(
  :radius_servers,
  :radius_port,
  :radius_timeout,
  :radius_retries,
  :shared_secret,
  :authentication_protocol,
  :display_label,
  :use_same_username)
  SENSITIVE = [:shared_secret]
  include Aws::Structure
end