interface ClientAuthenticationRequestProperty

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.EC2.Mixins.CfnClientVpnEndpointPropsMixin.ClientAuthenticationRequestProperty`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsec2/mixins#CfnClientVpnEndpointPropsMixin_ClientAuthenticationRequestProperty`
Java	`software.amazon.awscdk.mixins.preview.services.ec2.mixins.CfnClientVpnEndpointPropsMixin.ClientAuthenticationRequestProperty`
Python	`aws_cdk.mixins_preview.aws_ec2.mixins.CfnClientVpnEndpointPropsMixin.ClientAuthenticationRequestProperty`
TypeScript	`@aws-cdk/mixins-preview` » `aws_ec2` » `mixins` » `CfnClientVpnEndpointPropsMixin` » `ClientAuthenticationRequestProperty`

Describes the authentication method to be used by a Client VPN endpoint.

For more information, see Authentication in the AWS Client VPN Administrator Guide .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as ec2_mixins } from '@aws-cdk/mixins-preview/aws-ec2';
const clientAuthenticationRequestProperty: ec2_mixins.CfnClientVpnEndpointPropsMixin.ClientAuthenticationRequestProperty = {
  activeDirectory: {
    directoryId: 'directoryId',
  },
  federatedAuthentication: {
    samlProviderArn: 'samlProviderArn',
    selfServiceSamlProviderArn: 'selfServiceSamlProviderArn',
  },
  mutualAuthentication: {
    clientRootCertificateChainArn: 'clientRootCertificateChainArn',
  },
  type: 'type',
};

Properties

Name	Type	Description
activeDirectory?	`IResolvable` `\|` `DirectoryServiceAuthenticationRequestProperty`	Information about the Active Directory to be used, if applicable.
federatedAuthentication?	`IResolvable` `\|` `FederatedAuthenticationRequestProperty`	Information about the IAM SAML identity provider, if applicable.
mutualAuthentication?	`IResolvable` `\|` `CertificateAuthenticationRequestProperty`	Information about the authentication certificates to be used, if applicable.
type?	`string`	The type of client authentication to be used.

activeDirectory?

Type: IResolvable | DirectoryServiceAuthenticationRequestProperty (optional)

Information about the Active Directory to be used, if applicable.

You must provide this information if Type is directory-service-authentication .

federatedAuthentication?

Type: IResolvable | FederatedAuthenticationRequestProperty (optional)

Information about the IAM SAML identity provider, if applicable.

mutualAuthentication?

Type: IResolvable | CertificateAuthenticationRequestProperty (optional)

Information about the authentication certificates to be used, if applicable.

You must provide this information if Type is certificate-authentication .

type?

Type: string (optional)

The type of client authentication to be used.

AWS CDK

2.232.1