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

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

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

Overview

Note:

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

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

Describes the authentication method to be used by a Client VPN endpoint. Client VPN supports Active Directory and mutual authentication. 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:



3427
3428
3429
3430
3431
3432
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3427

class ClientVpnAuthenticationRequest < Struct.new(
  :type,
  :active_directory,
  :mutual_authentication)
  include Aws::Structure
end

#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:



3427
3428
3429
3430
3431
3432
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3427

class ClientVpnAuthenticationRequest < Struct.new(
  :type,
  :active_directory,
  :mutual_authentication)
  include Aws::Structure
end

#type ⇒ String

The type of client authentication to be used. Specify certificate-authentication to use certificate-based authentication, or directory-service-authentication to use Active Directory authentication.

Returns:

  • (String) 


3427
3428
3429
3430
3431
3432
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3427

class ClientVpnAuthenticationRequest < Struct.new(
  :type,
  :active_directory,
  :mutual_authentication)
  include Aws::Structure
end