Class CfnClientVpnEndpoint
A CloudFormation AWS::EC2::ClientVpnEndpoint
.
Inherited Members
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.AWS.EC2.dll
Syntax (csharp)
public class CfnClientVpnEndpoint : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnClientVpnEndpoint
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Specifies a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.
CloudformationResource: AWS::EC2::ClientVpnEndpoint
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 cfnClientVpnEndpoint = new CfnClientVpnEndpoint(this, "MyCfnClientVpnEndpoint", new CfnClientVpnEndpointProps {
AuthenticationOptions = new [] { 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"
}
} },
ClientCidrBlock = "clientCidrBlock",
ConnectionLogOptions = new ConnectionLogOptionsProperty {
Enabled = false,
// the properties below are optional
CloudwatchLogGroup = "cloudwatchLogGroup",
CloudwatchLogStream = "cloudwatchLogStream"
},
ServerCertificateArn = "serverCertificateArn",
// the properties below are optional
ClientConnectOptions = new ClientConnectOptionsProperty {
Enabled = false,
// the properties below are optional
LambdaFunctionArn = "lambdaFunctionArn"
},
ClientLoginBannerOptions = new ClientLoginBannerOptionsProperty {
Enabled = false,
// the properties below are optional
BannerText = "bannerText"
},
Description = "description",
DnsServers = new [] { "dnsServers" },
SecurityGroupIds = new [] { "securityGroupIds" },
SelfServicePortal = "selfServicePortal",
SessionTimeoutHours = 123,
SplitTunnel = false,
TagSpecifications = new [] { new TagSpecificationProperty {
ResourceType = "resourceType",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
} },
TransportProtocol = "transportProtocol",
VpcId = "vpcId",
VpnPort = 123
});
Synopsis
Constructors
CfnClientVpnEndpoint(Construct, String, ICfnClientVpnEndpointProps) | Create a new |
CfnClientVpnEndpoint(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnClientVpnEndpoint(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AuthenticationOptions | Information about the authentication method to be used to authenticate clients. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ClientCidrBlock | The IPv4 address range, in CIDR notation, from which to assign client IP addresses. |
ClientConnectOptions | The options for managing connection authorization for new client connections. |
ClientLoginBannerOptions | Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established. |
ConnectionLogOptions | Information about the client connection logging options. |
Description | A brief description of the Client VPN endpoint. |
DnsServers | Information about the DNS servers to be used for DNS resolution. |
SecurityGroupIds | The IDs of one or more security groups to apply to the target network. |
SelfServicePortal | Specify whether to enable the self-service portal for the Client VPN endpoint. |
ServerCertificateArn | The ARN of the server certificate. |
SessionTimeoutHours | The maximum VPN session duration time in hours. |
SplitTunnel | Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint. |
TagSpecifications | The tags to apply to the Client VPN endpoint during creation. |
TransportProtocol | The transport protocol to be used by the VPN session. |
VpcId | The ID of the VPC to associate with the Client VPN endpoint. |
VpnPort | The port number to assign to the Client VPN endpoint for TCP and UDP traffic. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnClientVpnEndpoint(Construct, String, ICfnClientVpnEndpointProps)
Create a new AWS::EC2::ClientVpnEndpoint
.
public CfnClientVpnEndpoint(Construct scope, string id, ICfnClientVpnEndpointProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnClientVpnEndpointProps
- resource properties.
CfnClientVpnEndpoint(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnClientVpnEndpoint(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnClientVpnEndpoint(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnClientVpnEndpoint(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AuthenticationOptions
Information about the authentication method to be used to authenticate clients.
public virtual object AuthenticationOptions { get; set; }
Property Value
System.Object
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ClientCidrBlock
The IPv4 address range, in CIDR notation, from which to assign client IP addresses.
public virtual string ClientCidrBlock { get; set; }
Property Value
System.String
Remarks
The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. Client CIDR range must have a size of at least /22 and must not be greater than /12.
ClientConnectOptions
The options for managing connection authorization for new client connections.
public virtual object ClientConnectOptions { get; set; }
Property Value
System.Object
Remarks
ClientLoginBannerOptions
Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
public virtual object ClientLoginBannerOptions { get; set; }
Property Value
System.Object
Remarks
ConnectionLogOptions
Information about the client connection logging options.
public virtual object ConnectionLogOptions { get; set; }
Property Value
System.Object
Remarks
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
Description
A brief description of the Client VPN endpoint.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
DnsServers
Information about the DNS servers to be used for DNS resolution.
public virtual string[] DnsServers { get; set; }
Property Value
System.String[]
Remarks
A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.
SecurityGroupIds
The IDs of one or more security groups to apply to the target network.
public virtual string[] SecurityGroupIds { get; set; }
Property Value
System.String[]
Remarks
You must also specify the ID of the VPC that contains the security groups.
SelfServicePortal
Specify whether to enable the self-service portal for the Client VPN endpoint.
public virtual string SelfServicePortal { get; set; }
Property Value
System.String
Remarks
ServerCertificateArn
The ARN of the server certificate.
public virtual string ServerCertificateArn { get; set; }
Property Value
System.String
Remarks
SessionTimeoutHours
The maximum VPN session duration time in hours.
public virtual Nullable<double> SessionTimeoutHours { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Valid values: 8 | 10 | 12 | 24
Default value: 24
SplitTunnel
Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
public virtual object SplitTunnel { get; set; }
Property Value
System.Object
Remarks
By default, split-tunnel on a VPN endpoint is disabled.
For information about split-tunnel VPN endpoints, see Split-tunnel AWS Client VPN endpoint in the AWS Client VPN Administrator Guide .
TagSpecifications
The tags to apply to the Client VPN endpoint during creation.
public virtual object TagSpecifications { get; set; }
Property Value
System.Object
Remarks
TransportProtocol
The transport protocol to be used by the VPN session.
public virtual string TransportProtocol { get; set; }
Property Value
System.String
Remarks
VpcId
The ID of the VPC to associate with the Client VPN endpoint.
public virtual string VpcId { get; set; }
Property Value
System.String
Remarks
If no security group IDs are specified in the request, the default security group for the VPC is applied.
VpnPort
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
public virtual Nullable<double> VpnPort { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Valid Values: 443
| 1194
Default Value: 443
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>