Class: Aws::EC2::Types::ClientVpnAuthenticationRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EC2::Types::ClientVpnAuthenticationRequest
- Defined in:
- gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb
Overview
When making an API call, you may pass ClientVpnAuthenticationRequest data as a 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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#active_directory ⇒ Types::DirectoryServiceAuthenticationRequest
Information about the Active Directory to be used, if applicable.
-
#federated_authentication ⇒ Types::FederatedAuthenticationRequest
Information about the IAM SAML identity provider to be used, if applicable.
-
#mutual_authentication ⇒ Types::CertificateAuthenticationRequest
Information about the authentication certificates to be used, if applicable.
-
#type ⇒ String
The type of client authentication to be used.
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
.
4200 4201 4202 4203 4204 4205 4206 4207 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4200 class ClientVpnAuthenticationRequest < Struct.new( :type, :active_directory, :mutual_authentication, :federated_authentication) SENSITIVE = [] include Aws::Structure end |
#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
.
4200 4201 4202 4203 4204 4205 4206 4207 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4200 class ClientVpnAuthenticationRequest < Struct.new( :type, :active_directory, :mutual_authentication, :federated_authentication) SENSITIVE = [] 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
.
4200 4201 4202 4203 4204 4205 4206 4207 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4200 class ClientVpnAuthenticationRequest < Struct.new( :type, :active_directory, :mutual_authentication, :federated_authentication) SENSITIVE = [] include Aws::Structure end |
#type ⇒ String
The type of client authentication to be used.
4200 4201 4202 4203 4204 4205 4206 4207 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 4200 class ClientVpnAuthenticationRequest < Struct.new( :type, :active_directory, :mutual_authentication, :federated_authentication) SENSITIVE = [] include Aws::Structure end |