Package software.amazon.awscdk.services.ec2

Interface CfnClientVpnEndpoint.ClientAuthenticationRequestProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnClientVpnEndpoint.ClientAuthenticationRequestProperty.Jsii$Proxy

Enclosing class:

CfnClientVpnEndpoint

@Stability(Stable)
public static interface CfnClientVpnEndpoint.ClientAuthenticationRequestProperty
extends software.amazon.jsii.JsiiSerializable

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 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnClientVpnEndpoint.ClientAuthenticationRequestProperty.Builder	A builder for CfnClientVpnEndpoint.ClientAuthenticationRequestProperty
static final class	CfnClientVpnEndpoint.ClientAuthenticationRequestProperty.Jsii$Proxy	An implementation for CfnClientVpnEndpoint.ClientAuthenticationRequestProperty

Method Summary

Modifier and Type	Method	Description
static CfnClientVpnEndpoint.ClientAuthenticationRequestProperty.Builder	builder()
default Object	getActiveDirectory()	Information about the Active Directory to be used, if applicable.
default Object	getFederatedAuthentication()	Information about the IAM SAML identity provider, if applicable.
default Object	getMutualAuthentication()	Information about the authentication certificates to be used, if applicable.
String	getType()	The type of client authentication to be used.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@NotNull
String getType()

The type of client authentication to be used.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-type

getActiveDirectory

@Stability(Stable)
@Nullable
default Object getActiveDirectory()

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-activedirectory

getFederatedAuthentication

@Stability(Stable)
@Nullable
default Object getFederatedAuthentication()

Information about the IAM SAML identity provider, if applicable.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-federatedauthentication

getMutualAuthentication

@Stability(Stable)
@Nullable
default Object getMutualAuthentication()

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-clientvpnendpoint-clientauthenticationrequest.html#cfn-ec2-clientvpnendpoint-clientauthenticationrequest-mutualauthentication

builder

@Stability(Stable)
static CfnClientVpnEndpoint.ClientAuthenticationRequestProperty.Builder builder()

Returns:

a CfnClientVpnEndpoint.ClientAuthenticationRequestProperty.Builder of CfnClientVpnEndpoint.ClientAuthenticationRequestProperty