Modifies the specified Client VPN endpoint¶

Description¶

Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.

Usage¶

ec2_modify_client_vpn_endpoint(ClientVpnEndpointId,
  ServerCertificateArn, ConnectionLogOptions, DnsServers, VpnPort,
  Description, SplitTunnel, DryRun, SecurityGroupIds, VpcId,
  SelfServicePortal, ClientConnectOptions, SessionTimeoutHours,
  ClientLoginBannerOptions, ClientRouteEnforcementOptions,
  DisconnectOnSessionTimeout, TransitGatewayConfiguration,
  DevicePostureOptions)

Arguments¶

• ClientVpnEndpointId

  [required] The ID of the Client VPN endpoint to modify.

• ServerCertificateArn

  The ARN of the server certificate to be used. The server certificate must be provisioned in Certificate Manager (ACM).

• ConnectionLogOptions

  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

• DnsServers

  Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers.

• VpnPort

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

  Valid Values: 443 | 1194

  Default Value: 443

• Description

  A brief description of the Client VPN endpoint.

• SplitTunnel

  Indicates whether the VPN is split-tunnel.

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

• DryRun

  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

  The IDs of one or more security groups to apply to the target network.

• VpcId

  The ID of the VPC to associate with the Client VPN endpoint.

• SelfServicePortal

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

• ClientConnectOptions

  The options for managing connection authorization for new client connections.

• SessionTimeoutHours

  The maximum VPN session duration time in hours.

  Valid values: 8 | 10 | 12 | 24

  Default value: 24

• ClientLoginBannerOptions

  Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.

• ClientRouteEnforcementOptions

  Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.

  Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations.

• DisconnectOnSessionTimeout

  Indicates whether the client VPN session is disconnected after the maximum timeout specified in sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is true.

• TransitGatewayConfiguration

  The Transit Gateway configuration for the Client VPN endpoint. This option is currently not supported.

• DevicePostureOptions

  The device posture options for the Client VPN endpoint. Specifying this parameter replaces the entire device posture configuration for the endpoint. To remove all device trust providers, specify an empty list.

Value¶

A list with the following syntax:

list(
  Return = TRUE|FALSE
)

Request syntax¶

svc$modify_client_vpn_endpoint(
  ClientVpnEndpointId = "string",
  ServerCertificateArn = "string",
  ConnectionLogOptions = list(
    Enabled = TRUE|FALSE,
    CloudwatchLogGroup = "string",
    CloudwatchLogStream = "string",
    IncludeAuthorizationPolicyContext = TRUE|FALSE
  ),
  DnsServers = list(
    CustomDnsServers = list(
      "string"
    ),
    Enabled = TRUE|FALSE
  ),
  VpnPort = 123,
  Description = "string",
  SplitTunnel = TRUE|FALSE,
  DryRun = TRUE|FALSE,
  SecurityGroupIds = list(
    "string"
  ),
  VpcId = "string",
  SelfServicePortal = "enabled"|"disabled",
  ClientConnectOptions = list(
    Enabled = TRUE|FALSE,
    LambdaFunctionArn = "string"
  ),
  SessionTimeoutHours = 123,
  ClientLoginBannerOptions = list(
    Enabled = TRUE|FALSE,
    BannerText = "string"
  ),
  ClientRouteEnforcementOptions = list(
    Enforced = TRUE|FALSE
  ),
  DisconnectOnSessionTimeout = TRUE|FALSE,
  TransitGatewayConfiguration = list(
    TransitGatewayId = "string",
    AvailabilityZones = list(
      "string"
    ),
    AvailabilityZoneIds = list(
      "string"
    )
  ),
  DevicePostureOptions = list(
    TrustProviders = list(
      list(
        TrustProviderType = "crowdstrike"|"jamf"|"jumpcloud",
        TenantId = "string",
        PublicSigningKeyUrl = "string"
      )
    ),
    Enabled = TRUE|FALSE
  )
)