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

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::ClientVpnEndpoint

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

Describes a Client VPN endpoint.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #associated_target_networks ⇒ Array<Types::AssociatedTargetNetwork>

  Information about the associated target networks.

• #authentication_options ⇒ Array<Types::ClientVpnAuthentication>

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

• #client_cidr_block ⇒ String

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

• #client_connect_options ⇒ Types::ClientConnectResponseOptions

  The options for managing connection authorization for new client connections.

• #client_login_banner_options ⇒ Types::ClientLoginBannerResponseOptions

  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.

• #connection_log_options ⇒ Types::ConnectionLogResponseOptions

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

• #creation_time ⇒ String

  The date and time the Client VPN endpoint was created.

• #deletion_time ⇒ String

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

• #description ⇒ String

  A brief description of the endpoint.

• #disconnect_on_session_timeout ⇒ Boolean

  Indicates whether the client VPN session is disconnected after the maximum ‘sessionTimeoutHours` is reached.

• #dns_name ⇒ String

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

• #dns_servers ⇒ Array<String>

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

• #security_group_ids ⇒ Array<String>

  The IDs of the security groups for the target network.

• #self_service_portal_url ⇒ String

  The URL of the self-service portal.

• #server_certificate_arn ⇒ String

  The ARN of the server certificate.

• #session_timeout_hours ⇒ Integer

  The maximum VPN session duration time in hours.

• #split_tunnel ⇒ Boolean

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

• #status ⇒ Types::ClientVpnEndpointStatus

  The current state of the Client VPN endpoint.

• #tags ⇒ Array<Types::Tag>

  Any tags assigned to the Client VPN endpoint.

• #transport_protocol ⇒ String

  The transport protocol used by the Client VPN endpoint.

• #vpc_id ⇒ String

  The ID of the VPC.

• #vpn_port ⇒ Integer

  The port number for the Client VPN endpoint.

• #vpn_protocol ⇒ String

  The protocol used by the VPN session.

Instance Attribute Details

#associated_target_networks ⇒ Array<Types::AssociatedTargetNetwork>

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

Returns:

• (Array<Types::AssociatedTargetNetwork>)

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

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

#authentication_options ⇒ Array<Types::ClientVpnAuthentication>

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

Returns:

• (Array<Types::ClientVpnAuthentication>)

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

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

#client_cidr_block ⇒ String

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

Returns:

• (String)

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

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

#client_connect_options ⇒ Types::ClientConnectResponseOptions

The options for managing connection authorization for new client connections.

Returns:

• (Types::ClientConnectResponseOptions)

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

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

#client_login_banner_options ⇒ Types::ClientLoginBannerResponseOptions

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::ClientLoginBannerResponseOptions)

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

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

#client_vpn_endpoint_id ⇒ String

The ID of the Client VPN endpoint.

Returns:

• (String)

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

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

#connection_log_options ⇒ Types::ConnectionLogResponseOptions

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

Returns:

• (Types::ConnectionLogResponseOptions)

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

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

#creation_time ⇒ String

The date and time the Client VPN endpoint was created.

Returns:

• (String)

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

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

#deletion_time ⇒ String

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

Returns:

• (String)

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

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

#description ⇒ String

A brief description of the endpoint.

Returns:

• (String)

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

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

#disconnect_on_session_timeout ⇒ Boolean

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

Returns:

• (Boolean)

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

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

#dns_name ⇒ String

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

Returns:

• (String)

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

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

#dns_servers ⇒ Array<String>

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

Returns:

• (Array<String>)

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

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

#security_group_ids ⇒ Array<String>

The IDs of the security groups for the target network.

Returns:

• (Array<String>)

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

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

#self_service_portal_url ⇒ String

The URL of the self-service portal.

Returns:

• (String)

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

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

#server_certificate_arn ⇒ String

The ARN of the server certificate.

Returns:

• (String)

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

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,
  :session_timeout_hours,
  :client_login_banner_options,
  :disconnect_on_session_timeout)
  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 6416

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

#split_tunnel ⇒ Boolean

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

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

Returns:

• (Boolean)

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

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

#status ⇒ Types::ClientVpnEndpointStatus

The current state of the Client VPN endpoint.

Returns:

• (Types::ClientVpnEndpointStatus)

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

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

#tags ⇒ Array<Types::Tag>

Any tags assigned to the Client VPN endpoint.

Returns:

• (Array<Types::Tag>)

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

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

#transport_protocol ⇒ String

The transport protocol used by the Client VPN endpoint.

Returns:

• (String)

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

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

#vpc_id ⇒ String

The ID of the VPC.

Returns:

• (String)

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

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

#vpn_port ⇒ Integer

The port number for the Client VPN endpoint.

Returns:

• (Integer)

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

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

#vpn_protocol ⇒ String

The protocol used by the VPN session.

Returns:

• (String)

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

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