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

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.

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_protocolString

The protocol specified for your RADIUS endpoints.

Returns:

  • (String)


2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2177

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

#display_labelString

Not currently used.

Returns:

  • (String)


2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2177

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

#radius_portInteger

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

Returns:

  • (Integer)


2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2177

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

#radius_retriesInteger

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

Returns:

  • (Integer)


2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2177

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

#radius_serversArray<String>

An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your RADIUS server load balancer.

Returns:

  • (Array<String>)


2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2177

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

#radius_timeoutInteger

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

Returns:

  • (Integer)


2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2177

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

#shared_secretString

Not currently used.

Returns:

  • (String)


2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2177

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

#use_same_usernameBoolean

Not currently used.

Returns:

  • (Boolean)


2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/types.rb', line 2177

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