Interface CfnClientVpnEndpoint.IClientAuthenticationRequestProperty

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

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnClientVpnEndpoint.IClientAuthenticationRequestProperty

Syntax (vb)

Public Interface CfnClientVpnEndpoint.IClientAuthenticationRequestProperty

Remarks

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

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

ExampleMetadata: fixture=_generated

Examples

// 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"
                 }
             };

Synopsis

Properties

ActiveDirectory	Information about the Active Directory to be used, if applicable.
FederatedAuthentication	Information about the IAM SAML identity provider, if applicable.
MutualAuthentication	Information about the authentication certificates to be used, if applicable.
Type	The type of client authentication to be used.

Properties

ActiveDirectory

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

object? ActiveDirectory { get; }

Property Value

object

Remarks

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

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

FederatedAuthentication

Information about the IAM SAML identity provider, if applicable.

object? FederatedAuthentication { get; }

Property Value

object

Remarks

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

MutualAuthentication

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

object? MutualAuthentication { get; }

Property Value

object

Remarks

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

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

Type

The type of client authentication to be used.

string Type { get; }

Property Value

string

Remarks

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