Package software.amazon.awssdk.services.securityhub.model

Class AwsEc2ClientVpnEndpointDetails

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

Describes an Client VPN endpoint. A Client VPN endpoint is the resource that you create and configure to enable and manage client VPN sessions. It's the termination point for all client VPN sessions.

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.

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

    • hasDnsServer

      public final boolean hasDnsServer()
      For responses, this returns true if the service returned a value for the DnsServer 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.

    • dnsServer

      public final List<String> dnsServer()

      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 hasDnsServer() 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.

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

    • transportProtocol

      public final String transportProtocol()

      The transport protocol used by the Client VPN endpoint.

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

    • vpnPort

      public final Integer vpnPort()

      The port number for the Client VPN endpoint.

      Returns:
      The port number for the Client VPN endpoint.

    • serverCertificateArn

      public final String serverCertificateArn()

      The Amazon Resource Name (ARN) of the server certificate.

      Returns:
      The Amazon Resource Name (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<AwsEc2ClientVpnEndpointAuthenticationOptionsDetails> 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 AwsEc2ClientVpnEndpointConnectionLogOptionsDetails 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.

    • hasSecurityGroupIdSet

      public final boolean hasSecurityGroupIdSet()
      For responses, this returns true if the service returned a value for the SecurityGroupIdSet 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.

    • securityGroupIdSet

      public final List<String> securityGroupIdSet()

      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 hasSecurityGroupIdSet() 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 AwsEc2ClientVpnEndpointClientConnectOptionsDetails 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.

      Returns:
      The maximum VPN session duration time in hours.

    • clientLoginBannerOptions

      public final AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails 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 AwsEc2ClientVpnEndpointDetails.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<AwsEc2ClientVpnEndpointDetails.Builder,AwsEc2ClientVpnEndpointDetails>
      Returns:
      a builder for type T

    • builder

      public static AwsEc2ClientVpnEndpointDetails.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AwsEc2ClientVpnEndpointDetails.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.