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: "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",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_connect_optionsTypes::ClientConnectOptions

The options for managing connection authorization for new client connections.



39658
39659
39660
39661
39662
39663
39664
39665
39666
39667
39668
39669
39670
39671
39672
39673
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39658

class ModifyClientVpnEndpointRequest < Struct.new(
  :client_vpn_endpoint_id,
  :server_certificate_arn,
  :connection_log_options,
  :dns_servers,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#client_vpn_endpoint_idString

The ID of the Client VPN endpoint to modify.

Returns:

  • (String)


39658
39659
39660
39661
39662
39663
39664
39665
39666
39667
39668
39669
39670
39671
39672
39673
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39658

class ModifyClientVpnEndpointRequest < Struct.new(
  :client_vpn_endpoint_id,
  :server_certificate_arn,
  :connection_log_options,
  :dns_servers,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options)
  SENSITIVE = []
  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



39658
39659
39660
39661
39662
39663
39664
39665
39666
39667
39668
39669
39670
39671
39672
39673
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39658

class ModifyClientVpnEndpointRequest < Struct.new(
  :client_vpn_endpoint_id,
  :server_certificate_arn,
  :connection_log_options,
  :dns_servers,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A brief description of the Client VPN endpoint.

Returns:

  • (String)


39658
39659
39660
39661
39662
39663
39664
39665
39666
39667
39668
39669
39670
39671
39672
39673
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39658

class ModifyClientVpnEndpointRequest < Struct.new(
  :client_vpn_endpoint_id,
  :server_certificate_arn,
  :connection_log_options,
  :dns_servers,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options)
  SENSITIVE = []
  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.



39658
39659
39660
39661
39662
39663
39664
39665
39666
39667
39668
39669
39670
39671
39672
39673
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39658

class ModifyClientVpnEndpointRequest < Struct.new(
  :client_vpn_endpoint_id,
  :server_certificate_arn,
  :connection_log_options,
  :dns_servers,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options)
  SENSITIVE = []
  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)


39658
39659
39660
39661
39662
39663
39664
39665
39666
39667
39668
39669
39670
39671
39672
39673
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39658

class ModifyClientVpnEndpointRequest < Struct.new(
  :client_vpn_endpoint_id,
  :server_certificate_arn,
  :connection_log_options,
  :dns_servers,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_idsArray<String>

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

Returns:

  • (Array<String>)


39658
39659
39660
39661
39662
39663
39664
39665
39666
39667
39668
39669
39670
39671
39672
39673
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39658

class ModifyClientVpnEndpointRequest < Struct.new(
  :client_vpn_endpoint_id,
  :server_certificate_arn,
  :connection_log_options,
  :dns_servers,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#self_service_portalString

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

Returns:

  • (String)


39658
39659
39660
39661
39662
39663
39664
39665
39666
39667
39668
39669
39670
39671
39672
39673
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39658

class ModifyClientVpnEndpointRequest < Struct.new(
  :client_vpn_endpoint_id,
  :server_certificate_arn,
  :connection_log_options,
  :dns_servers,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options)
  SENSITIVE = []
  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)


39658
39659
39660
39661
39662
39663
39664
39665
39666
39667
39668
39669
39670
39671
39672
39673
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39658

class ModifyClientVpnEndpointRequest < Struct.new(
  :client_vpn_endpoint_id,
  :server_certificate_arn,
  :connection_log_options,
  :dns_servers,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options)
  SENSITIVE = []
  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)


39658
39659
39660
39661
39662
39663
39664
39665
39666
39667
39668
39669
39670
39671
39672
39673
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39658

class ModifyClientVpnEndpointRequest < Struct.new(
  :client_vpn_endpoint_id,
  :server_certificate_arn,
  :connection_log_options,
  :dns_servers,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_idString

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

Returns:

  • (String)


39658
39659
39660
39661
39662
39663
39664
39665
39666
39667
39668
39669
39670
39671
39672
39673
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39658

class ModifyClientVpnEndpointRequest < Struct.new(
  :client_vpn_endpoint_id,
  :server_certificate_arn,
  :connection_log_options,
  :dns_servers,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#vpn_portInteger

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

Valid Values: 443 | 1194

Default Value: 443

Returns:

  • (Integer)


39658
39659
39660
39661
39662
39663
39664
39665
39666
39667
39668
39669
39670
39671
39672
39673
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 39658

class ModifyClientVpnEndpointRequest < Struct.new(
  :client_vpn_endpoint_id,
  :server_certificate_arn,
  :connection_log_options,
  :dns_servers,
  :vpn_port,
  :description,
  :split_tunnel,
  :dry_run,
  :security_group_ids,
  :vpc_id,
  :self_service_portal,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end