Class: Aws::EC2::Types::ModifyClientVpnEndpointRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EC2::Types::ModifyClientVpnEndpointRequest
- 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_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.
46958 46959 46960 46961 46962 46963 46964 46965 46966 46967 46968 46969 46970 46971 46972 46973 46974 46975 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46958 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.
46958 46959 46960 46961 46962 46963 46964 46965 46966 46967 46968 46969 46970 46971 46972 46973 46974 46975 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46958 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.
46958 46959 46960 46961 46962 46963 46964 46965 46966 46967 46968 46969 46970 46971 46972 46973 46974 46975 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46958 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
46958 46959 46960 46961 46962 46963 46964 46965 46966 46967 46968 46969 46970 46971 46972 46973 46974 46975 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46958 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.
46958 46959 46960 46961 46962 46963 46964 46965 46966 46967 46968 46969 46970 46971 46972 46973 46974 46975 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46958 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.
46958 46959 46960 46961 46962 46963 46964 46965 46966 46967 46968 46969 46970 46971 46972 46973 46974 46975 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46958 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
.
46958 46959 46960 46961 46962 46963 46964 46965 46966 46967 46968 46969 46970 46971 46972 46973 46974 46975 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46958 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.
46958 46959 46960 46961 46962 46963 46964 46965 46966 46967 46968 46969 46970 46971 46972 46973 46974 46975 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46958 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.
46958 46959 46960 46961 46962 46963 46964 46965 46966 46967 46968 46969 46970 46971 46972 46973 46974 46975 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46958 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).
46958 46959 46960 46961 46962 46963 46964 46965 46966 46967 46968 46969 46970 46971 46972 46973 46974 46975 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46958 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
46958 46959 46960 46961 46962 46963 46964 46965 46966 46967 46968 46969 46970 46971 46972 46973 46974 46975 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46958 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.
46958 46959 46960 46961 46962 46963 46964 46965 46966 46967 46968 46969 46970 46971 46972 46973 46974 46975 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46958 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.
46958 46959 46960 46961 46962 46963 46964 46965 46966 46967 46968 46969 46970 46971 46972 46973 46974 46975 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46958 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
46958 46959 46960 46961 46962 46963 46964 46965 46966 46967 46968 46969 46970 46971 46972 46973 46974 46975 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46958 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 |