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",
  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)


25184
25185
25186
25187
25188
25189
25190
25191
25192
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 25184

class ModifyClientVpnEndpointRequest < Struct.new(
  :client_vpn_endpoint_id,
  :server_certificate_arn,
  :connection_log_options,
  :dns_servers,
  :description,
  :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



25184
25185
25186
25187
25188
25189
25190
25191
25192
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 25184

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

#descriptionString

A brief description of the Client VPN endpoint.

Returns:

  • (String)


25184
25185
25186
25187
25188
25189
25190
25191
25192
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 25184

class ModifyClientVpnEndpointRequest < Struct.new(
  :client_vpn_endpoint_id,
  :server_certificate_arn,
  :connection_log_options,
  :dns_servers,
  :description,
  :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.



25184
25185
25186
25187
25188
25189
25190
25191
25192
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 25184

class ModifyClientVpnEndpointRequest < Struct.new(
  :client_vpn_endpoint_id,
  :server_certificate_arn,
  :connection_log_options,
  :dns_servers,
  :description,
  :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)


25184
25185
25186
25187
25188
25189
25190
25191
25192
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 25184

class ModifyClientVpnEndpointRequest < Struct.new(
  :client_vpn_endpoint_id,
  :server_certificate_arn,
  :connection_log_options,
  :dns_servers,
  :description,
  :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)


25184
25185
25186
25187
25188
25189
25190
25191
25192
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 25184

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