This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::EC2::ClientVpnEndpoint ClientAuthenticationRequest
<a name="aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest"></a>

Describes the authentication method to be used by a Client VPN endpoint. For more information, see [Authentication](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/authentication-authrization.html#client-authentication) in the *AWS Client VPN Administrator Guide*.

## Syntax
<a name="aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest-syntax"></a>

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

### JSON
<a name="aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest-syntax.json"></a>

```
{
  "[ActiveDirectory](#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-activedirectory)" : DirectoryServiceAuthenticationRequest,
  "[FederatedAuthentication](#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-federatedauthentication)" : FederatedAuthenticationRequest,
  "[MutualAuthentication](#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-mutualauthentication)" : CertificateAuthenticationRequest,
  "[Type](#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-type)" : String
}
```

### YAML
<a name="aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest-syntax.yaml"></a>

```
  [ActiveDirectory](#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-activedirectory): 
    DirectoryServiceAuthenticationRequest
  [FederatedAuthentication](#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-federatedauthentication): 
    FederatedAuthenticationRequest
  [MutualAuthentication](#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-mutualauthentication): 
    CertificateAuthenticationRequest
  [Type](#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-type): String
```

## Properties
<a name="aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest-properties"></a>

`ActiveDirectory`  <a name="cfn-ec2-clientvpnendpoint-clientauthenticationrequest-activedirectory"></a>
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](aws-properties-ec2-clientvpnendpoint-directoryserviceauthenticationrequest.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`FederatedAuthentication`  <a name="cfn-ec2-clientvpnendpoint-clientauthenticationrequest-federatedauthentication"></a>
Information about the IAM SAML identity provider, if applicable.  
*Required*: No  
*Type*: [FederatedAuthenticationRequest](aws-properties-ec2-clientvpnendpoint-federatedauthenticationrequest.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MutualAuthentication`  <a name="cfn-ec2-clientvpnendpoint-clientauthenticationrequest-mutualauthentication"></a>
Information about the authentication certificates to be used, if applicable. You must provide this information if **Type** is `certificate-authentication`.  
*Required*: No  
*Type*: [CertificateAuthenticationRequest](aws-properties-ec2-clientvpnendpoint-certificateauthenticationrequest.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Type`  <a name="cfn-ec2-clientvpnendpoint-clientauthenticationrequest-type"></a>
The type of client authentication to be used.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `certificate-authentication | directory-service-authentication | federated-authentication`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)