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

Inherits:

Struct

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

show all

Defined in:: gems/aws-sdk-ec2/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_route_enforcement_options ⇒ Types::ClientRouteEnforcementOptions
Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN.
#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.
#device_posture_options ⇒ Types::DevicePostureOptions
The device posture options for the Client VPN endpoint.
#disconnect_on_session_timeout ⇒ Boolean
Indicates whether the client VPN session is disconnected after the maximum timeout specified in sessionTimeoutHours is reached.
#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.
#transit_gateway_configuration ⇒ Types::TransitGatewayConfigurationInputStructure
The Transit Gateway configuration for the Client VPN endpoint.
#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 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 65640

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,
  :client_route_enforcement_options,
  :disconnect_on_session_timeout,
  :transit_gateway_configuration,
  :device_posture_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 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 65640

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,
  :client_route_enforcement_options,
  :disconnect_on_session_timeout,
  :transit_gateway_configuration,
  :device_posture_options)
  SENSITIVE = []
  include Aws::Structure
end

#client_route_enforcement_options ⇒ `Types::ClientRouteEnforcementOptions`

Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.

Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations.

Returns:

(Types::ClientRouteEnforcementOptions)

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

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,
  :client_route_enforcement_options,
  :disconnect_on_session_timeout,
  :transit_gateway_configuration,
  :device_posture_options)
  SENSITIVE = []
  include Aws::Structure
end

#client_vpn_endpoint_id ⇒ `String`

The ID of the Client VPN endpoint to modify.

Returns:

(String)

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

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,
  :client_route_enforcement_options,
  :disconnect_on_session_timeout,
  :transit_gateway_configuration,
  :device_posture_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 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 65640

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,
  :client_route_enforcement_options,
  :disconnect_on_session_timeout,
  :transit_gateway_configuration,
  :device_posture_options)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

A brief description of the Client VPN endpoint.

Returns:

(String)

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

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,
  :client_route_enforcement_options,
  :disconnect_on_session_timeout,
  :transit_gateway_configuration,
  :device_posture_options)
  SENSITIVE = []
  include Aws::Structure
end

#device_posture_options ⇒ `Types::DevicePostureOptions`

The device posture options for the Client VPN endpoint. Specifying this parameter replaces the entire device posture configuration for the endpoint. To remove all device trust providers, specify an empty list.

Returns:

(Types::DevicePostureOptions)

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

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,
  :client_route_enforcement_options,
  :disconnect_on_session_timeout,
  :transit_gateway_configuration,
  :device_posture_options)
  SENSITIVE = []
  include Aws::Structure
end

#disconnect_on_session_timeout ⇒ `Boolean`

Indicates whether the client VPN session is disconnected after the maximum timeout specified in sessionTimeoutHours is reached. If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically. The default value is true.

Returns:

(Boolean)

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

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,
  :client_route_enforcement_options,
  :disconnect_on_session_timeout,
  :transit_gateway_configuration,
  :device_posture_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 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 65640

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,
  :client_route_enforcement_options,
  :disconnect_on_session_timeout,
  :transit_gateway_configuration,
  :device_posture_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 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 65640

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,
  :client_route_enforcement_options,
  :disconnect_on_session_timeout,
  :transit_gateway_configuration,
  :device_posture_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 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 65640

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,
  :client_route_enforcement_options,
  :disconnect_on_session_timeout,
  :transit_gateway_configuration,
  :device_posture_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 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 65640

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,
  :client_route_enforcement_options,
  :disconnect_on_session_timeout,
  :transit_gateway_configuration,
  :device_posture_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 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 65640

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,
  :client_route_enforcement_options,
  :disconnect_on_session_timeout,
  :transit_gateway_configuration,
  :device_posture_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 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 65640

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,
  :client_route_enforcement_options,
  :disconnect_on_session_timeout,
  :transit_gateway_configuration,
  :device_posture_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.

Returns:

(Boolean)

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

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,
  :client_route_enforcement_options,
  :disconnect_on_session_timeout,
  :transit_gateway_configuration,
  :device_posture_options)
  SENSITIVE = []
  include Aws::Structure
end

#transit_gateway_configuration ⇒ `Types::TransitGatewayConfigurationInputStructure`

The Transit Gateway configuration for the Client VPN endpoint. This option is currently not supported.

Returns:

(Types::TransitGatewayConfigurationInputStructure)

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

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,
  :client_route_enforcement_options,
  :disconnect_on_session_timeout,
  :transit_gateway_configuration,
  :device_posture_options)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ `String`

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

Returns:

(String)

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

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,
  :client_route_enforcement_options,
  :disconnect_on_session_timeout,
  :transit_gateway_configuration,
  :device_posture_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 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 65640

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,
  :client_route_enforcement_options,
  :disconnect_on_session_timeout,
  :transit_gateway_configuration,
  :device_posture_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_route_enforcement_options ⇒ Types::ClientRouteEnforcementOptions

#client_vpn_endpoint_id ⇒ String

#connection_log_options ⇒ Types::ConnectionLogOptions

#description ⇒ String

#device_posture_options ⇒ Types::DevicePostureOptions

#disconnect_on_session_timeout ⇒ Boolean

#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

#transit_gateway_configuration ⇒ Types::TransitGatewayConfigurationInputStructure

#vpc_id ⇒ String

#vpn_port ⇒ Integer

#client_connect_options ⇒ `Types::ClientConnectOptions`

#client_login_banner_options ⇒ `Types::ClientLoginBannerOptions`

#client_route_enforcement_options ⇒ `Types::ClientRouteEnforcementOptions`

#client_vpn_endpoint_id ⇒ `String`

#connection_log_options ⇒ `Types::ConnectionLogOptions`

#description ⇒ `String`

#device_posture_options ⇒ `Types::DevicePostureOptions`

#disconnect_on_session_timeout ⇒ `Boolean`

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

#transit_gateway_configuration ⇒ `Types::TransitGatewayConfigurationInputStructure`

#vpc_id ⇒ `String`

#vpn_port ⇒ `Integer`