Class RadiusSettings
- java.lang.Object
-
- software.amazon.awssdk.services.directory.model.RadiusSettings
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<RadiusSettings.Builder,RadiusSettings>
@Generated("software.amazon.awssdk:codegen") public final class RadiusSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RadiusSettings.Builder,RadiusSettings>
Contains information about a Remote Authentication Dial In User Service (RADIUS) server.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceRadiusSettings.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description RadiusAuthenticationProtocolauthenticationProtocol()The protocol specified for your RADIUS endpoints.StringauthenticationProtocolAsString()The protocol specified for your RADIUS endpoints.static RadiusSettings.Builderbuilder()StringdisplayLabel()Not currently used.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasRadiusServers()For responses, this returns true if the service returned a value for the RadiusServers property.IntegerradiusPort()The port that your RADIUS server is using for communications.IntegerradiusRetries()The maximum number of times that communication with the RADIUS server is retried after the initial attempt.List<String>radiusServers()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.IntegerradiusTimeout()The amount of time, in seconds, to wait for the RADIUS server to respond.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends RadiusSettings.Builder>serializableBuilderClass()StringsharedSecret()Required for enabling RADIUS on the directory.RadiusSettings.BuildertoBuilder()StringtoString()Returns a string representation of this object.BooleanuseSameUsername()Not currently used.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
hasRadiusServers
public final boolean hasRadiusServers()
For responses, this returns true if the service returned a value for the RadiusServers property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
radiusServers
public final List<String> radiusServers()
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRadiusServers()method.- Returns:
- 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.
-
radiusPort
public final Integer radiusPort()
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:
- 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.
-
radiusTimeout
public final Integer radiusTimeout()
The amount of time, in seconds, to wait for the RADIUS server to respond.
- Returns:
- The amount of time, in seconds, to wait for the RADIUS server to respond.
-
radiusRetries
public final Integer radiusRetries()
The maximum number of times that communication with the RADIUS server is retried after the initial attempt.
- Returns:
- The maximum number of times that communication with the RADIUS server is retried after the initial attempt.
-
sharedSecret
public final String sharedSecret()
Required for enabling RADIUS on the directory.
- Returns:
- Required for enabling RADIUS on the directory.
-
authenticationProtocol
public final RadiusAuthenticationProtocol authenticationProtocol()
The protocol specified for your RADIUS endpoints.
If the service returns an enum value that is not available in the current SDK version,
authenticationProtocolwill returnRadiusAuthenticationProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromauthenticationProtocolAsString().- Returns:
- The protocol specified for your RADIUS endpoints.
- See Also:
RadiusAuthenticationProtocol
-
authenticationProtocolAsString
public final String authenticationProtocolAsString()
The protocol specified for your RADIUS endpoints.
If the service returns an enum value that is not available in the current SDK version,
authenticationProtocolwill returnRadiusAuthenticationProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromauthenticationProtocolAsString().- Returns:
- The protocol specified for your RADIUS endpoints.
- See Also:
RadiusAuthenticationProtocol
-
displayLabel
public final String displayLabel()
Not currently used.
- Returns:
- Not currently used.
-
useSameUsername
public final Boolean useSameUsername()
Not currently used.
- Returns:
- Not currently used.
-
toBuilder
public RadiusSettings.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<RadiusSettings.Builder,RadiusSettings>
-
builder
public static RadiusSettings.Builder builder()
-
serializableBuilderClass
public static Class<? extends RadiusSettings.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-