AWS::EC2::ClientVpnEndpoint ClientAuthenticationRequest

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "ActiveDirectory" : DirectoryServiceAuthenticationRequest,
  "FederatedAuthentication" : FederatedAuthenticationRequest,
  "MutualAuthentication" : CertificateAuthenticationRequest,
  "Type" : String
}

YAML

  ActiveDirectory: 
    DirectoryServiceAuthenticationRequest
  FederatedAuthentication: 
    FederatedAuthenticationRequest
  MutualAuthentication: 
    CertificateAuthenticationRequest
  Type: String

Properties

ActiveDirectory

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

Required: No

Type: DirectoryServiceAuthenticationRequest

Update requires: Replacement

FederatedAuthentication

Information about the IAM SAML identity provider, if applicable.

Required: No

Type: FederatedAuthenticationRequest

Update requires: Replacement

MutualAuthentication

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

Required: No

Type: CertificateAuthenticationRequest

Update requires: Replacement

Type

The type of client authentication to be used.

Required: Yes

Type: String

Allowed values: certificate-authentication | directory-service-authentication | federated-authentication

Update requires: Replacement