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

Class: Aws::EC2::Types::ClientVpnAuthenticationRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ClientVpnAuthenticationRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  type: "certificate-authentication", # accepts certificate-authentication, directory-service-authentication, federated-authentication
  active_directory: {
    directory_id: "String",
  },
  mutual_authentication: {
    client_root_certificate_chain_arn: "String",
  },
  federated_authentication: {
    saml_provider_arn: "String",
    self_service_saml_provider_arn: "String",
  },
}

Describes the authentication method to be used by a Client VPN endpoint. For more information, see Authentication in the AWS Client VPN Administrator Guide.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#active_directory ⇒ Types::DirectoryServiceAuthenticationRequest

Information about the Active Directory to be used, if applicable. You must provide this information if Type is directory-service-authentication.

Returns:

#federated_authentication ⇒ Types::FederatedAuthenticationRequest

Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if Type is federated-authentication.

Returns:

#mutual_authentication ⇒ Types::CertificateAuthenticationRequest

Information about the authentication certificates to be used, if applicable. You must provide this information if Type is certificate-authentication.

Returns:

#type ⇒ String

The type of client authentication to be used.

Possible values:

  • certificate-authentication
  • directory-service-authentication
  • federated-authentication

Returns:

  • (String) —

    The type of client authentication to be used.