Package software.amazon.awssdk.services.ec2.model

Class ClientVpnEndpoint

java.lang.Object
software.amazon.awssdk.services.ec2.model.ClientVpnEndpoint
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ClientVpnEndpoint.Builder,ClientVpnEndpoint>
@Generated("software.amazon.awssdk:codegen") public final class ClientVpnEndpoint extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ClientVpnEndpoint.Builder,ClientVpnEndpoint>

Describes a Client VPN endpoint.

See Also:

  • Method Details

    • clientVpnEndpointId

      public final String clientVpnEndpointId()

      The ID of the Client VPN endpoint.

      Returns:
      The ID of the Client VPN endpoint.

    • description

      public final String description()

      A brief description of the endpoint.

      Returns:
      A brief description of the endpoint.

    • status

      public final ClientVpnEndpointStatus status()

      The current state of the Client VPN endpoint.

      Returns:
      The current state of the Client VPN endpoint.

    • creationTime

      public final String creationTime()

      The date and time the Client VPN endpoint was created.

      Returns:
      The date and time the Client VPN endpoint was created.

    • deletionTime

      public final String deletionTime()

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

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

    • dnsName

      public final String dnsName()

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

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

    • clientCidrBlock

      public final String clientCidrBlock()

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

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

    • hasDnsServers

      public final boolean hasDnsServers()
      For responses, this returns true if the service returned a value for the DnsServers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • dnsServers

      public final List<String> dnsServers()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDnsServers() method.

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

    • splitTunnel

      public final Boolean splitTunnel()

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

    • vpnProtocol

      public final VpnProtocol vpnProtocol()

      The protocol used by the VPN session.

      If the service returns an enum value that is not available in the current SDK version, vpnProtocol will return VpnProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vpnProtocolAsString().

      Returns:
      The protocol used by the VPN session.
      See Also:

    • vpnProtocolAsString

      public final String vpnProtocolAsString()

      The protocol used by the VPN session.

      If the service returns an enum value that is not available in the current SDK version, vpnProtocol will return VpnProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vpnProtocolAsString().

      Returns:
      The protocol used by the VPN session.
      See Also:

    • transportProtocol

      public final TransportProtocol transportProtocol()

      The transport protocol used by the Client VPN endpoint.

      If the service returns an enum value that is not available in the current SDK version, transportProtocol will return TransportProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from transportProtocolAsString().

      Returns:
      The transport protocol used by the Client VPN endpoint.
      See Also:

    • transportProtocolAsString

      public final String transportProtocolAsString()

      The transport protocol used by the Client VPN endpoint.

      If the service returns an enum value that is not available in the current SDK version, transportProtocol will return TransportProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from transportProtocolAsString().

      Returns:
      The transport protocol used by the Client VPN endpoint.
      See Also:

    • vpnPort

      public final Integer vpnPort()

      The port number for the Client VPN endpoint.

      Returns:
      The port number for the Client VPN endpoint.

    • hasAssociatedTargetNetworks

      @Deprecated public final boolean hasAssociatedTargetNetworks()
      Deprecated.
      This property is deprecated. To view the target networks associated with a Client VPN endpoint, call DescribeClientVpnTargetNetworks and inspect the clientVpnTargetNetworks response element.
      For responses, this returns true if the service returned a value for the AssociatedTargetNetworks property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • associatedTargetNetworks

      @Deprecated public final List<AssociatedTargetNetwork> associatedTargetNetworks()
      Deprecated.
      This property is deprecated. To view the target networks associated with a Client VPN endpoint, call DescribeClientVpnTargetNetworks and inspect the clientVpnTargetNetworks response element.

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAssociatedTargetNetworks() method.

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

    • serverCertificateArn

      public final String serverCertificateArn()

      The ARN of the server certificate.

      Returns:
      The ARN of the server certificate.

    • hasAuthenticationOptions

      public final boolean hasAuthenticationOptions()
      For responses, this returns true if the service returned a value for the AuthenticationOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • authenticationOptions

      public final List<ClientVpnAuthentication> authenticationOptions()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAuthenticationOptions() method.

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

    • connectionLogOptions

      public final ConnectionLogResponseOptions connectionLogOptions()

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

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

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      Any tags assigned to the Client VPN endpoint.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Any tags assigned to the Client VPN endpoint.

    • hasSecurityGroupIds

      public final boolean hasSecurityGroupIds()
      For responses, this returns true if the service returned a value for the SecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • securityGroupIds

      public final List<String> securityGroupIds()

      The IDs of the security groups for the target network.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroupIds() method.

      Returns:
      The IDs of the security groups for the target network.

    • vpcId

      public final String vpcId()

      The ID of the VPC.

      Returns:
      The ID of the VPC.

    • selfServicePortalUrl

      public final String selfServicePortalUrl()

      The URL of the self-service portal.

      Returns:
      The URL of the self-service portal.

    • clientConnectOptions

      public final ClientConnectResponseOptions clientConnectOptions()

      The options for managing connection authorization for new client connections.

      Returns:
      The options for managing connection authorization for new client connections.

    • sessionTimeoutHours

      public final Integer sessionTimeoutHours()

      The maximum VPN session duration time in hours.

      Valid values: 8 | 10 | 12 | 24

      Default value: 24

      Returns:
      The maximum VPN session duration time in hours.

      Valid values: 8 | 10 | 12 | 24

      Default value: 24

    • clientLoginBannerOptions

      public final ClientLoginBannerResponseOptions clientLoginBannerOptions()

      Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.

      Returns:
      Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.

    • toBuilder

      public ClientVpnEndpoint.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ClientVpnEndpoint.Builder,ClientVpnEndpoint>
      Returns:
      a builder for type T

    • builder

      public static ClientVpnEndpoint.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ClientVpnEndpoint.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.