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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes a Client VPN endpoint.

See Also:

Instance Attribute Summary collapse

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:

#authentication_options ⇒ Array<Types::ClientVpnAuthentication>

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

Returns:

#client_cidr_block ⇒ String

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

Returns:

  • (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.

Returns:

#client_vpn_endpoint_id ⇒ String

The ID of the Client VPN endpoint.

Returns:

  • (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.

Returns:

#creation_time ⇒ String

The date and time the Client VPN endpoint was created.

Returns:

  • (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.

Returns:

  • (String) —

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

#description ⇒ String

A brief description of the endpoint.

Returns:

  • (String) —

    A brief description of the endpoint.

#dns_name ⇒ String

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

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (Array<String>) —

    The IDs of the security groups for the target network.

#self_service_portal_url ⇒ String

The URL of the self-service portal.

Returns:

  • (String) —

    The URL of the self-service portal.

#server_certificate_arn ⇒ String

The ARN of the server certificate.

Returns:

  • (String) —

    The ARN of the server certificate.

#split_tunnel ⇒ Boolean

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

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

Returns:

  • (Boolean) —

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

#status ⇒ Types::ClientVpnEndpointStatus

The current state of the Client VPN endpoint.

Returns:

#tags ⇒ Array<Types::Tag>

Any tags assigned to the Client VPN endpoint.

Returns:

  • (Array<Types::Tag>) —

    Any tags assigned to the Client VPN endpoint.

#transport_protocol ⇒ String

The transport protocol used by the Client VPN endpoint.

Possible values:

  • tcp
  • udp

Returns:

  • (String) —

    The transport protocol used by the Client VPN endpoint.

#vpc_id ⇒ String

The ID of the VPC.

Returns:

  • (String) —

    The ID of the VPC.

#vpn_port ⇒ Integer

The port number for the Client VPN endpoint.

Returns:

  • (Integer) —

    The port number for the Client VPN endpoint.

#vpn_protocol ⇒ String

The protocol used by the VPN session.

Possible values:

  • openvpn

Returns:

  • (String) —

    The protocol used by the VPN session.