You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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.

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:



3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3194

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,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags)
  include Aws::Structure
end

#authentication_optionsArray<Types::ClientVpnAuthentication>

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

Returns:



3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3194

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,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags)
  include Aws::Structure
end

#client_cidr_blockString

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

Returns:

  • (String)


3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3194

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,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags)
  include Aws::Structure
end

#client_vpn_endpoint_idString

The ID of the Client VPN endpoint.

Returns:

  • (String)


3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3194

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,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags)
  include Aws::Structure
end

#connection_log_optionsTypes::ConnectionLogResponseOptions

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



3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3194

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,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags)
  include Aws::Structure
end

#creation_timeString

The date and time the Client VPN endpoint was created.

Returns:

  • (String)


3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3194

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,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags)
  include Aws::Structure
end

#deletion_timeString

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

Returns:

  • (String)


3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3194

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,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags)
  include Aws::Structure
end

#descriptionString

A brief description of the endpoint.

Returns:

  • (String)


3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3194

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,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags)
  include Aws::Structure
end

#dns_nameString

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

Returns:

  • (String)


3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3194

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,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags)
  include Aws::Structure
end

#dns_serversArray<String>

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

Returns:

  • (Array<String>)


3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3194

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,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags)
  include Aws::Structure
end

#server_certificate_arnString

The ARN of the server certificate.

Returns:

  • (String)


3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3194

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,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags)
  include Aws::Structure
end

#split_tunnelBoolean

Indicates whether VPN split tunneling is supported.

Returns:

  • (Boolean)


3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3194

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,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags)
  include Aws::Structure
end

#statusTypes::ClientVpnEndpointStatus

The current state of the Client VPN endpoint.



3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3194

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,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags)
  include Aws::Structure
end

#tagsArray<Types::Tag>

Any tags assigned to the Client VPN endpoint.

Returns:



3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3194

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,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags)
  include Aws::Structure
end

#transport_protocolString

The transport protocol used by the Client VPN endpoint.

Returns:

  • (String)


3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3194

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,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags)
  include Aws::Structure
end

#vpn_protocolString

The protocol used by the VPN session.

Returns:

  • (String)


3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 3194

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,
  :associated_target_networks,
  :server_certificate_arn,
  :authentication_options,
  :connection_log_options,
  :tags)
  include Aws::Structure
end