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

Inherits:

Struct

Object
Struct
Aws::EC2::Types::ModifyClientVpnEndpointRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-ec2/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#client_connect_options ⇒ Types::ClientConnectOptions

The options for managing connection authorization for new client connections.
#client_login_banner_options ⇒ Types::ClientLoginBannerOptions

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

The ID of the Client VPN endpoint to modify.
#connection_log_options ⇒ Types::ConnectionLogOptions

Information about the client connection logging options.
#description ⇒ 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.
#dry_run ⇒ 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.
#self_service_portal ⇒ 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.
#session_timeout_hours ⇒ Integer

The maximum VPN session duration time in hours.
#split_tunnel ⇒ Boolean

Indicates whether the VPN is split-tunnel.
#vpc_id ⇒ 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.

Instance Attribute Details

#client_connect_options ⇒ `Types::ClientConnectOptions`

The options for managing connection authorization for new client connections.

Returns:

(Types::ClientConnectOptions)

# File 'lib/aws-sdk-ec2/types.rb', line 46420

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,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#client_login_banner_options ⇒ `Types::ClientLoginBannerOptions`

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

Returns:

(Types::ClientLoginBannerOptions)

# File 'lib/aws-sdk-ec2/types.rb', line 46420

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,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#client_vpn_endpoint_id ⇒ `String`

The ID of the Client VPN endpoint to modify.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 46420

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,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

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

(Types::ConnectionLogOptions)

# File 'lib/aws-sdk-ec2/types.rb', line 46420

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,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

A brief description of the Client VPN endpoint.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 46420

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,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

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

(Types::DnsServersOptionsModifyStructure)

# File 'lib/aws-sdk-ec2/types.rb', line 46420

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,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-ec2/types.rb', line 46420

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,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_ids ⇒ `Array<String>`

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

Returns:

(Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 46420

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,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#self_service_portal ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 46420

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,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#server_certificate_arn ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 46420

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,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#session_timeout_hours ⇒ `Integer`

The maximum VPN session duration time in hours.

Valid values: ‘8 | 10 | 12 | 24`

Default value: ‘24`

Returns:

(Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 46420

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,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#split_tunnel ⇒ `Boolean`

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*.

[1]: docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html

Returns:

(Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 46420

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,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 46420

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,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-ec2/types.rb', line 46420

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,
  :session_timeout_hours,
  :client_login_banner_options)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#client_connect_options ⇒ Types::ClientConnectOptions

#client_login_banner_options ⇒ Types::ClientLoginBannerOptions

#client_vpn_endpoint_id ⇒ String

#connection_log_options ⇒ Types::ConnectionLogOptions

#description ⇒ String

#dns_servers ⇒ Types::DnsServersOptionsModifyStructure

#dry_run ⇒ Boolean

#security_group_ids ⇒ Array<String>

#self_service_portal ⇒ String

#server_certificate_arn ⇒ String

#session_timeout_hours ⇒ Integer

#split_tunnel ⇒ Boolean

#vpc_id ⇒ String

#vpn_port ⇒ Integer

#client_connect_options ⇒ `Types::ClientConnectOptions`

#client_login_banner_options ⇒ `Types::ClientLoginBannerOptions`

#client_vpn_endpoint_id ⇒ `String`

#connection_log_options ⇒ `Types::ConnectionLogOptions`

#description ⇒ `String`

#dns_servers ⇒ `Types::DnsServersOptionsModifyStructure`

#dry_run ⇒ `Boolean`

#security_group_ids ⇒ `Array<String>`

#self_service_portal ⇒ `String`

#server_certificate_arn ⇒ `String`

#session_timeout_hours ⇒ `Integer`

#split_tunnel ⇒ `Boolean`

#vpc_id ⇒ `String`

#vpn_port ⇒ `Integer`