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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass ModifyClientVpnEndpointRequest data as a hash:

{
  client_vpn_endpoint_id: "String", # 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,
  },
  description: "String",
  split_tunnel: false,
  dry_run: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_vpn_endpoint_idString

The ID of the Client VPN endpoint to modify.

Returns:

  • (String)


27106
27107
27108
27109
27110
27111
27112
27113
27114
27115
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 27106

class ModifyClientVpnEndpointRequest < Struct.new(
  :client_vpn_endpoint_id,
  :server_certificate_arn,
  :connection_log_options,
  :dns_servers,
  :description,
  :split_tunnel,
  :dry_run)
  include Aws::Structure
end

#connection_log_optionsTypes::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



27106
27107
27108
27109
27110
27111
27112
27113
27114
27115
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 27106

class ModifyClientVpnEndpointRequest < Struct.new(
  :client_vpn_endpoint_id,
  :server_certificate_arn,
  :connection_log_options,
  :dns_servers,
  :description,
  :split_tunnel,
  :dry_run)
  include Aws::Structure
end

#descriptionString

A brief description of the Client VPN endpoint.

Returns:

  • (String)


27106
27107
27108
27109
27110
27111
27112
27113
27114
27115
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 27106

class ModifyClientVpnEndpointRequest < Struct.new(
  :client_vpn_endpoint_id,
  :server_certificate_arn,
  :connection_log_options,
  :dns_servers,
  :description,
  :split_tunnel,
  :dry_run)
  include Aws::Structure
end

#dns_serversTypes::DnsServersOptionsModifyStructure

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



27106
27107
27108
27109
27110
27111
27112
27113
27114
27115
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 27106

class ModifyClientVpnEndpointRequest < Struct.new(
  :client_vpn_endpoint_id,
  :server_certificate_arn,
  :connection_log_options,
  :dns_servers,
  :description,
  :split_tunnel,
  :dry_run)
  include Aws::Structure
end

#dry_runBoolean

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)


27106
27107
27108
27109
27110
27111
27112
27113
27114
27115
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 27106

class ModifyClientVpnEndpointRequest < Struct.new(
  :client_vpn_endpoint_id,
  :server_certificate_arn,
  :connection_log_options,
  :dns_servers,
  :description,
  :split_tunnel,
  :dry_run)
  include Aws::Structure
end

#server_certificate_arnString

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

Returns:

  • (String)


27106
27107
27108
27109
27110
27111
27112
27113
27114
27115
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 27106

class ModifyClientVpnEndpointRequest < Struct.new(
  :client_vpn_endpoint_id,
  :server_certificate_arn,
  :connection_log_options,
  :dns_servers,
  :description,
  :split_tunnel,
  :dry_run)
  include Aws::Structure
end

#split_tunnelBoolean

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)


27106
27107
27108
27109
27110
27111
27112
27113
27114
27115
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 27106

class ModifyClientVpnEndpointRequest < Struct.new(
  :client_vpn_endpoint_id,
  :server_certificate_arn,
  :connection_log_options,
  :dns_servers,
  :description,
  :split_tunnel,
  :dry_run)
  include Aws::Structure
end