CreateClientVpnEndpointRequest

import type { CreateClientVpnEndpointRequest } from "https://aws-api.deno.dev/v0.3/services/ec2.ts?docs=full";

interface CreateClientVpnEndpointRequest {

AuthenticationOptions: ClientVpnAuthenticationRequest[];

ClientCidrBlock: string;

ClientConnectOptions?: ClientConnectOptions | null;

ClientLoginBannerOptions?: ClientLoginBannerOptions | null;

ClientToken?: string | null;

ConnectionLogOptions: ConnectionLogOptions;

Description?: string | null;

DnsServers?: string[] | null;

DryRun?: boolean | null;

SecurityGroupIds?: string[] | null;

SelfServicePortal?: SelfServicePortal | null;

ServerCertificateArn: string;

SessionTimeoutHours?: number | null;

SplitTunnel?: boolean | null;

TagSpecifications?: TagSpecification[] | null;

TransportProtocol?: TransportProtocol | null;

VpcId?: string | null;

VpnPort?: number | null;

}

§Properties

AuthenticationOptions: ClientVpnAuthenticationRequest[]

[src]

Information about the authentication method to be used to authenticate clients.

ClientCidrBlock: string

[src]

The IPv4 address range, in CIDR notation, from which to assign client IP addresses. 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. The CIDR block should be /22 or greater.

ClientConnectOptions?: ClientConnectOptions | null

[src]

The options for managing connection authorization for new client connections.

ClientLoginBannerOptions?: ClientLoginBannerOptions | null

[src]

ClientToken?: string | null

[src]

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

ConnectionLogOptions: ConnectionLogOptions

[src]

Information about the client connection logging options.

If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:

Client connection requests
Client connection results (successful and unsuccessful)
Reasons for unsuccessful client connection requests
Client connection termination time

Description?: string | null

[src]

A brief description of the Client VPN endpoint.

DnsServers?: string[] | null

[src]

Information about the DNS servers to be used for DNS resolution. 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.

DryRun?: boolean | null

[src]

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

SecurityGroupIds?: string[] | null

[src]

The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.

SelfServicePortal?: SelfServicePortal | null

[src]

Specify whether to enable the self-service portal for the Client VPN endpoint.

Default Value: enabled

ServerCertificateArn: string

[src]

The ARN of the server certificate. For more information, see the Certificate Manager User Guide.

SessionTimeoutHours?: number | null

[src]

SplitTunnel?: boolean | null

[src]

Indicates whether split-tunnel is enabled on the Client VPN endpoint.

By default, split-tunnel on a VPN endpoint is disabled.

For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.

TagSpecifications?: TagSpecification[] | null

[src]

The tags to apply to the Client VPN endpoint during creation.

TransportProtocol?: TransportProtocol | null

[src]

The transport protocol to be used by the VPN session.

Default value: udp

VpcId?: string | null

[src]

The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.

VpnPort?: number | null

[src]

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

Valid Values: 443 | 1194

Default Value: 443