Class: Aws::EC2::Types::ClientVpnEndpoint

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Describes a Client VPN endpoint.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#associated_target_networksArray<Types::AssociatedTargetNetwork>

Information about the associated target networks. A target network is a subnet in a VPC.

Returns:



5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5198

class ClientVpnEndpoint < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :status,
  :creation_time,
  :deletion_time,
  :dns_name,
  :client_cidr_block,
  :dns_servers,
  :split_tunnel,
  :vpn_protocol,
  :transport_protocol,
  :vpn_port,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags,
  :security_group_ids,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#authentication_optionsArray<Types::ClientVpnAuthentication>

Information about the authentication method used by the Client VPN endpoint.

Returns:



5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5198

class ClientVpnEndpoint < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :status,
  :creation_time,
  :deletion_time,
  :dns_name,
  :client_cidr_block,
  :dns_servers,
  :split_tunnel,
  :vpn_protocol,
  :transport_protocol,
  :vpn_port,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags,
  :security_group_ids,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#client_cidr_blockString

The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.

Returns:

  • (String)


5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5198

class ClientVpnEndpoint < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :status,
  :creation_time,
  :deletion_time,
  :dns_name,
  :client_cidr_block,
  :dns_servers,
  :split_tunnel,
  :vpn_protocol,
  :transport_protocol,
  :vpn_port,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags,
  :security_group_ids,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#client_connect_optionsTypes::ClientConnectResponseOptions

The options for managing connection authorization for new client connections.



5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5198

class ClientVpnEndpoint < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :status,
  :creation_time,
  :deletion_time,
  :dns_name,
  :client_cidr_block,
  :dns_servers,
  :split_tunnel,
  :vpn_protocol,
  :transport_protocol,
  :vpn_port,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags,
  :security_group_ids,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#client_vpn_endpoint_idString

The ID of the Client VPN endpoint.

Returns:

  • (String)


5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5198

class ClientVpnEndpoint < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :status,
  :creation_time,
  :deletion_time,
  :dns_name,
  :client_cidr_block,
  :dns_servers,
  :split_tunnel,
  :vpn_protocol,
  :transport_protocol,
  :vpn_port,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags,
  :security_group_ids,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#connection_log_optionsTypes::ConnectionLogResponseOptions

Information about the client connection logging options for the Client VPN endpoint.



5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5198

class ClientVpnEndpoint < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :status,
  :creation_time,
  :deletion_time,
  :dns_name,
  :client_cidr_block,
  :dns_servers,
  :split_tunnel,
  :vpn_protocol,
  :transport_protocol,
  :vpn_port,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags,
  :security_group_ids,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#creation_timeString

The date and time the Client VPN endpoint was created.

Returns:

  • (String)


5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5198

class ClientVpnEndpoint < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :status,
  :creation_time,
  :deletion_time,
  :dns_name,
  :client_cidr_block,
  :dns_servers,
  :split_tunnel,
  :vpn_protocol,
  :transport_protocol,
  :vpn_port,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags,
  :security_group_ids,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_timeString

The date and time the Client VPN endpoint was deleted, if applicable.

Returns:

  • (String)


5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5198

class ClientVpnEndpoint < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :status,
  :creation_time,
  :deletion_time,
  :dns_name,
  :client_cidr_block,
  :dns_servers,
  :split_tunnel,
  :vpn_protocol,
  :transport_protocol,
  :vpn_port,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags,
  :security_group_ids,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A brief description of the endpoint.

Returns:

  • (String)


5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5198

class ClientVpnEndpoint < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :status,
  :creation_time,
  :deletion_time,
  :dns_name,
  :client_cidr_block,
  :dns_servers,
  :split_tunnel,
  :vpn_protocol,
  :transport_protocol,
  :vpn_port,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags,
  :security_group_ids,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#dns_nameString

The DNS name to be used by clients when connecting to the Client VPN endpoint.

Returns:

  • (String)


5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5198

class ClientVpnEndpoint < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :status,
  :creation_time,
  :deletion_time,
  :dns_name,
  :client_cidr_block,
  :dns_servers,
  :split_tunnel,
  :vpn_protocol,
  :transport_protocol,
  :vpn_port,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags,
  :security_group_ids,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#dns_serversArray<String>

Information about the DNS servers to be used for DNS resolution.

Returns:

  • (Array<String>)


5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5198

class ClientVpnEndpoint < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :status,
  :creation_time,
  :deletion_time,
  :dns_name,
  :client_cidr_block,
  :dns_servers,
  :split_tunnel,
  :vpn_protocol,
  :transport_protocol,
  :vpn_port,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags,
  :security_group_ids,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_idsArray<String>

The IDs of the security groups for the target network.

Returns:

  • (Array<String>)


5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5198

class ClientVpnEndpoint < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :status,
  :creation_time,
  :deletion_time,
  :dns_name,
  :client_cidr_block,
  :dns_servers,
  :split_tunnel,
  :vpn_protocol,
  :transport_protocol,
  :vpn_port,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags,
  :security_group_ids,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#self_service_portal_urlString

The URL of the self-service portal.

Returns:

  • (String)


5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5198

class ClientVpnEndpoint < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :status,
  :creation_time,
  :deletion_time,
  :dns_name,
  :client_cidr_block,
  :dns_servers,
  :split_tunnel,
  :vpn_protocol,
  :transport_protocol,
  :vpn_port,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags,
  :security_group_ids,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#server_certificate_arnString

The ARN of the server certificate.

Returns:

  • (String)


5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5198

class ClientVpnEndpoint < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :status,
  :creation_time,
  :deletion_time,
  :dns_name,
  :client_cidr_block,
  :dns_servers,
  :split_tunnel,
  :vpn_protocol,
  :transport_protocol,
  :vpn_port,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags,
  :security_group_ids,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#split_tunnelBoolean

Indicates whether split-tunnel is enabled in the Client VPN endpoint.

For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.

Returns:

  • (Boolean)


5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5198

class ClientVpnEndpoint < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :status,
  :creation_time,
  :deletion_time,
  :dns_name,
  :client_cidr_block,
  :dns_servers,
  :split_tunnel,
  :vpn_protocol,
  :transport_protocol,
  :vpn_port,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags,
  :security_group_ids,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#statusTypes::ClientVpnEndpointStatus

The current state of the Client VPN endpoint.



5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5198

class ClientVpnEndpoint < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :status,
  :creation_time,
  :deletion_time,
  :dns_name,
  :client_cidr_block,
  :dns_servers,
  :split_tunnel,
  :vpn_protocol,
  :transport_protocol,
  :vpn_port,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags,
  :security_group_ids,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

Any tags assigned to the Client VPN endpoint.

Returns:



5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5198

class ClientVpnEndpoint < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :status,
  :creation_time,
  :deletion_time,
  :dns_name,
  :client_cidr_block,
  :dns_servers,
  :split_tunnel,
  :vpn_protocol,
  :transport_protocol,
  :vpn_port,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags,
  :security_group_ids,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#transport_protocolString

The transport protocol used by the Client VPN endpoint.

Returns:

  • (String)


5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5198

class ClientVpnEndpoint < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :status,
  :creation_time,
  :deletion_time,
  :dns_name,
  :client_cidr_block,
  :dns_servers,
  :split_tunnel,
  :vpn_protocol,
  :transport_protocol,
  :vpn_port,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags,
  :security_group_ids,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_idString

The ID of the VPC.

Returns:

  • (String)


5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5198

class ClientVpnEndpoint < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :status,
  :creation_time,
  :deletion_time,
  :dns_name,
  :client_cidr_block,
  :dns_servers,
  :split_tunnel,
  :vpn_protocol,
  :transport_protocol,
  :vpn_port,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags,
  :security_group_ids,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#vpn_portInteger

The port number for the Client VPN endpoint.

Returns:

  • (Integer)


5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5198

class ClientVpnEndpoint < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :status,
  :creation_time,
  :deletion_time,
  :dns_name,
  :client_cidr_block,
  :dns_servers,
  :split_tunnel,
  :vpn_protocol,
  :transport_protocol,
  :vpn_port,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags,
  :security_group_ids,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end

#vpn_protocolString

The protocol used by the VPN session.

Returns:

  • (String)


5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5198

class ClientVpnEndpoint < Struct.new(
  :client_vpn_endpoint_id,
  :description,
  :status,
  :creation_time,
  :deletion_time,
  :dns_name,
  :client_cidr_block,
  :dns_servers,
  :split_tunnel,
  :vpn_protocol,
  :transport_protocol,
  :vpn_port,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags,
  :security_group_ids,
  :vpc_id,
  :self_service_portal_url,
  :client_connect_options)
  SENSITIVE = []
  include Aws::Structure
end