ClientAuthenticationRequestProperty Struct
Describes the authentication method to be used by a Client VPN endpoint.
For more information, see Authentication in the AWS Client VPN Administrator Guide .
| Source | |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const clientAuthenticationRequestProperty: ec2.CfnClientVpnEndpoint.ClientAuthenticationRequestProperty = {
type: 'type',
// the properties below are optional
activeDirectory: {
directoryId: 'directoryId',
},
federatedAuthentication: {
samlProviderArn: 'samlProviderArn',
// the properties below are optional
selfServiceSamlProviderArn: 'selfServiceSamlProviderArn',
},
mutualAuthentication: {
clientRootCertificateChainArn: 'clientRootCertificateChainArn',
},
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2
client_authentication_request_property = ec2.CfnClientVpnEndpoint.ClientAuthenticationRequestProperty(
type="type",
# the properties below are optional
active_directory=ec2.CfnClientVpnEndpoint.DirectoryServiceAuthenticationRequestProperty(
directory_id="directoryId"
),
federated_authentication=ec2.CfnClientVpnEndpoint.FederatedAuthenticationRequestProperty(
saml_provider_arn="samlProviderArn",
# the properties below are optional
self_service_saml_provider_arn="selfServiceSamlProviderArn"
),
mutual_authentication=ec2.CfnClientVpnEndpoint.CertificateAuthenticationRequestProperty(
client_root_certificate_chain_arn="clientRootCertificateChainArn"
)
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.ec2.*;
ClientAuthenticationRequestProperty clientAuthenticationRequestProperty = ClientAuthenticationRequestProperty.builder()
.type("type")
// the properties below are optional
.activeDirectory(DirectoryServiceAuthenticationRequestProperty.builder()
.directoryId("directoryId")
.build())
.federatedAuthentication(FederatedAuthenticationRequestProperty.builder()
.samlProviderArn("samlProviderArn")
// the properties below are optional
.selfServiceSamlProviderArn("selfServiceSamlProviderArn")
.build())
.mutualAuthentication(CertificateAuthenticationRequestProperty.builder()
.clientRootCertificateChainArn("clientRootCertificateChainArn")
.build())
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;
var clientAuthenticationRequestProperty = new ClientAuthenticationRequestProperty {
Type = "type",
// the properties below are optional
ActiveDirectory = new DirectoryServiceAuthenticationRequestProperty {
DirectoryId = "directoryId"
},
FederatedAuthentication = new FederatedAuthenticationRequestProperty {
SamlProviderArn = "samlProviderArn",
// the properties below are optional
SelfServiceSamlProviderArn = "selfServiceSamlProviderArn"
},
MutualAuthentication = new CertificateAuthenticationRequestProperty {
ClientRootCertificateChainArn = "clientRootCertificateChainArn"
}
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
clientAuthenticationRequestProperty := &ClientAuthenticationRequestProperty{
Type: jsii.String("type"),
// the properties below are optional
ActiveDirectory: &DirectoryServiceAuthenticationRequestProperty{
DirectoryId: jsii.String("directoryId"),
},
FederatedAuthentication: &FederatedAuthenticationRequestProperty{
SamlProviderArn: jsii.String("samlProviderArn"),
// the properties below are optional
SelfServiceSamlProviderArn: jsii.String("selfServiceSamlProviderArn"),
},
MutualAuthentication: &CertificateAuthenticationRequestProperty{
ClientRootCertificateChainArn: jsii.String("clientRootCertificateChainArn"),
},
}
Properties
activeDirectoryoptionalIResolvable | CfnClientVpnEndpoint.active_directoryoptionaltyping.Union[IResolvable, DirectoryServiceAuthenticationRequestProperty]activeDirectoryoptionalIResolvableActiveDirectoryoptionalIResolvableActiveDirectoryoptionalinterface{} #Information about the Active Directory to be used, if applicable.
You must provide this information if Type is directory-service-authentication .
federatedAuthenticationoptionalIResolvable | CfnClientVpnEndpoint.federated_authenticationoptionaltyping.Union[IResolvable, FederatedAuthenticationRequestProperty]federatedAuthenticationoptionalIResolvableFederatedAuthenticationoptionalIResolvableFederatedAuthenticationoptionalinterface{} #Information about the IAM SAML identity provider, if applicable.
mutualAuthenticationoptionalIResolvable | CfnClientVpnEndpoint.mutual_authenticationoptionaltyping.Union[IResolvable, CertificateAuthenticationRequestProperty]mutualAuthenticationoptionalIResolvableMutualAuthenticationoptionalIResolvableMutualAuthenticationoptionalinterface{} #Information about the authentication certificates to be used, if applicable.
You must provide this information if Type is certificate-authentication .
The type of client authentication to be used.