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.

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:

#authentication_optionsArray<Types::ClientVpnAuthentication>

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

Returns:

#client_cidr_blockString

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_vpn_endpoint_idString

The ID of the Client VPN endpoint.

Returns:

  • (String)

    The ID of the Client VPN endpoint.

#connection_log_optionsTypes::ConnectionLogResponseOptions

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

Returns:

#creation_timeString

The date and time the Client VPN endpoint was created.

Returns:

  • (String)

    The date and time the Client VPN endpoint was created.

#deletion_timeString

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.

#descriptionString

A brief description of the endpoint.

Returns:

  • (String)

    A brief description of the endpoint.

#dns_nameString

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_serversArray<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_idsArray<String>

The IDs of the security groups for the target network.

Returns:

  • (Array<String>)

    The IDs of the security groups for the target network.

#server_certificate_arnString

The ARN of the server certificate.

Returns:

  • (String)

    The ARN of the server certificate.

#split_tunnelBoolean

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.

#statusTypes::ClientVpnEndpointStatus

The current state of the Client VPN endpoint.

Returns:

#tagsArray<Types::Tag>

Any tags assigned to the Client VPN endpoint.

Returns:

  • (Array<Types::Tag>)

    Any tags assigned to the Client VPN endpoint.

#transport_protocolString

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_idString

The ID of the VPC.

Returns:

  • (String)

    The ID of the VPC.

#vpn_portInteger

The port number for the Client VPN endpoint.

Returns:

  • (Integer)

    The port number for the Client VPN endpoint.

#vpn_protocolString

The protocol used by the VPN session.

Possible values:

  • openvpn

Returns:

  • (String)

    The protocol used by the VPN session.