Class CfnClientVpnEndpoint.ClientAuthenticationRequestProperty

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

Inheritance

object

CfnClientVpnEndpoint.ClientAuthenticationRequestProperty

Implements

CfnClientVpnEndpoint.IClientAuthenticationRequestProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnClientVpnEndpoint.ClientAuthenticationRequestProperty : CfnClientVpnEndpoint.IClientAuthenticationRequestProperty

Syntax (vb)

Public Class CfnClientVpnEndpoint.ClientAuthenticationRequestProperty Implements 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

Constructors

ClientAuthenticationRequestProperty()

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

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.

Constructors

ClientAuthenticationRequestProperty()

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

public ClientAuthenticationRequestProperty()

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

Properties

ActiveDirectory

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

public object? ActiveDirectory { get; set; }

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

Type union: either IResolvable or CfnClientVpnEndpoint.IDirectoryServiceAuthenticationRequestProperty

FederatedAuthentication

Information about the IAM SAML identity provider, if applicable.

public object? FederatedAuthentication { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnClientVpnEndpoint.IFederatedAuthenticationRequestProperty

MutualAuthentication

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

public object? MutualAuthentication { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnClientVpnEndpoint.ICertificateAuthenticationRequestProperty

Type

The type of client authentication to be used.

public string Type { get; set; }