Class ClientVpnAuthenticationRequest
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ClientVpnAuthenticationRequest.Builder,
ClientVpnAuthenticationRequest>
Describes the authentication method to be used by a Client VPN endpoint. For more information, see Authentication in the Client VPN Administrator Guide.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionInformation about the Active Directory to be used, if applicable.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.Information about the IAM SAML identity provider to be used, if applicable.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
Information about the authentication certificates to be used, if applicable.static Class
<? extends ClientVpnAuthenticationRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.type()
The type of client authentication to be used.final String
The type of client authentication to be used.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
type
The type of client authentication to be used.
If the service returns an enum value that is not available in the current SDK version,
type
will returnClientVpnAuthenticationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of client authentication to be used.
- See Also:
-
typeAsString
The type of client authentication to be used.
If the service returns an enum value that is not available in the current SDK version,
type
will returnClientVpnAuthenticationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of client authentication to be used.
- See Also:
-
activeDirectory
Information about the Active Directory to be used, if applicable. You must provide this information if Type is
directory-service-authentication
.- Returns:
- Information about the Active Directory to be used, if applicable. You must provide this information if
Type is
directory-service-authentication
.
-
mutualAuthentication
Information about the authentication certificates to be used, if applicable. You must provide this information if Type is
certificate-authentication
.- Returns:
- Information about the authentication certificates to be used, if applicable. You must provide this
information if Type is
certificate-authentication
.
-
federatedAuthentication
Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if Type is
federated-authentication
.- Returns:
- Information about the IAM SAML identity provider to be used, if applicable. You must provide this
information if Type is
federated-authentication
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ClientVpnAuthenticationRequest.Builder,
ClientVpnAuthenticationRequest> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-