You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EC2::Types::ModifyClientVpnEndpointRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ModifyClientVpnEndpointRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  client_vpn_endpoint_id: "ClientVpnEndpointId", # required
  server_certificate_arn: "String",
  connection_log_options: {
    enabled: false,
    cloudwatch_log_group: "String",
    cloudwatch_log_stream: "String",
  },
  dns_servers: {
    custom_dns_servers: ["String"],
    enabled: false,
  },
  vpn_port: 1,
  description: "String",
  split_tunnel: false,
  dry_run: false,
  security_group_ids: ["SecurityGroupId"],
  vpc_id: "VpcId",
  self_service_portal: "enabled", # accepts enabled, disabled
  client_connect_options: {
    enabled: false,
    lambda_function_arn: "String",
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#client_connect_options ⇒ Types::ClientConnectOptions

The options for managing connection authorization for new client connections.

Returns:

#client_vpn_endpoint_id ⇒ String

The ID of the Client VPN endpoint to modify.

Returns:

  • (String) —

    The ID of the Client VPN endpoint to modify.

#connection_log_options ⇒ Types::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

Returns:

#description ⇒ String

A brief description of the Client VPN endpoint.

Returns:

  • (String) —

    A brief description of the Client VPN endpoint.

#dns_servers ⇒ Types::DnsServersOptionsModifyStructure

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

Returns:

#dry_run ⇒ Boolean

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.

Returns:

  • (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

#security_group_ids ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#self_service_portal ⇒ String

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

Possible values:

  • enabled
  • disabled

Returns:

  • (String) —

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

#server_certificate_arn ⇒ String

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

Returns:

  • (String) —

    The ARN of the server certificate to be used.

#split_tunnel ⇒ Boolean

Indicates whether the VPN is split-tunnel.

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

Returns:

  • (Boolean) —

    Indicates whether the VPN is split-tunnel.

#vpc_id ⇒ String

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

Returns:

  • (String) —

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

#vpn_port ⇒ Integer

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

Valid Values: 443 | 1194

Default Value: 443

Returns:

  • (Integer) —

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