ClientVpnEndpoint (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.ec2.model.ClientVpnEndpoint

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ClientVpnEndpoint.Builder,ClientVpnEndpoint>

@Generated(value="software.amazon.awssdk:codegen")
public final class ClientVpnEndpoint
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ClientVpnEndpoint.Builder,ClientVpnEndpoint>

Describes a Client VPN endpoint.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ClientVpnEndpoint.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ClientVpnEndpoint.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<AssociatedTargetNetwork>`	`associatedTargetNetworks()` Information about the associated target networks.
`List<ClientVpnAuthentication>`	`authenticationOptions()` Information about the authentication method used by the Client VPN endpoint.
`static ClientVpnEndpoint.Builder`	`builder()`
`String`	`clientCidrBlock()` The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
`String`	`clientVpnEndpointId()` The ID of the Client VPN endpoint.
`ConnectionLogResponseOptions`	`connectionLogOptions()` Information about the client connection logging options for the Client VPN endpoint.
`String`	`creationTime()` The date and time the Client VPN endpoint was created.
`String`	`deletionTime()` The date and time the Client VPN endpoint was deleted, if applicable.
`String`	`description()` A brief description of the endpoint.
`String`	`dnsName()` The DNS name to be used by clients when connecting to the Client VPN endpoint.
`List<String>`	`dnsServers()` Information about the DNS servers to be used for DNS resolution.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAssociatedTargetNetworks()` Returns true if the AssociatedTargetNetworks property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasAuthenticationOptions()` Returns true if the AuthenticationOptions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasDnsServers()` Returns true if the DnsServers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasSecurityGroupIds()` Returns true if the SecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroupIds()` The IDs of the security groups for the target network.
`static Class<? extends ClientVpnEndpoint.Builder>`	`serializableBuilderClass()`
`String`	`serverCertificateArn()` The ARN of the server certificate.
`Boolean`	`splitTunnel()` Indicates whether split-tunnel is enabled in the AWS Client VPN endpoint.
`ClientVpnEndpointStatus`	`status()` The current state of the Client VPN endpoint.
`List<Tag>`	`tags()` Any tags assigned to the Client VPN endpoint.
`ClientVpnEndpoint.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`TransportProtocol`	`transportProtocol()` The transport protocol used by the Client VPN endpoint.
`String`	`transportProtocolAsString()` The transport protocol used by the Client VPN endpoint.
`String`	`vpcId()` The ID of the VPC.
`Integer`	`vpnPort()` The port number for the Client VPN endpoint.
`VpnProtocol`	`vpnProtocol()` The protocol used by the VPN session.
`String`	`vpnProtocolAsString()` The protocol used by the VPN session.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - clientVpnEndpointId
```
public String clientVpnEndpointId()
```
    The ID of the Client VPN endpoint.
    
    Returns:
    
    The ID of the Client VPN endpoint.
  - description
```
public String description()
```
    A brief description of the endpoint.
    
    Returns:
    
    A brief description of the endpoint.
  - status
```
public ClientVpnEndpointStatus status()
```
    The current state of the Client VPN endpoint.
    
    Returns:
    
    The current state of the Client VPN endpoint.
  - creationTime
```
public 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 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 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 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 boolean hasDnsServers()
```
    Returns true if the DnsServers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - dnsServers
```
public 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.
    
    You can use hasDnsServers() to see if a value was sent in this field.
    
    Returns:
    
    Information about the DNS servers to be used for DNS resolution.
  - splitTunnel
```
public Boolean splitTunnel()
```
    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:
    
    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.
  - vpnProtocol
```
public 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:
    
    VpnProtocol
  - vpnProtocolAsString
```
public 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:
    
    VpnProtocol
  - transportProtocol
```
public 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:
    
    TransportProtocol
  - transportProtocolAsString
```
public 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:
    
    TransportProtocol
  - vpnPort
```
public Integer vpnPort()
```
    The port number for the Client VPN endpoint.
    
    Returns:
    
    The port number for the Client VPN endpoint.
  - hasAssociatedTargetNetworks
```
public boolean hasAssociatedTargetNetworks()
```
    Returns true if the AssociatedTargetNetworks property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - associatedTargetNetworks
```
public List<AssociatedTargetNetwork> associatedTargetNetworks()
```
    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.
    
    You can use hasAssociatedTargetNetworks() to see if a value was sent in this field.
    
    Returns:
    
    Information about the associated target networks. A target network is a subnet in a VPC.
  - serverCertificateArn
```
public String serverCertificateArn()
```
    The ARN of the server certificate.
    
    Returns:
    
    The ARN of the server certificate.
  - hasAuthenticationOptions
```
public boolean hasAuthenticationOptions()
```
    Returns true if the AuthenticationOptions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - authenticationOptions
```
public 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.
    
    You can use hasAuthenticationOptions() to see if a value was sent in this field.
    
    Returns:
    
    Information about the authentication method used by the Client VPN endpoint.
  - connectionLogOptions
```
public 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 boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    Any tags assigned to the Client VPN endpoint.
  - hasSecurityGroupIds
```
public boolean hasSecurityGroupIds()
```
    Returns true if the SecurityGroupIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - securityGroupIds
```
public 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.
    
    You can use hasSecurityGroupIds() to see if a value was sent in this field.
    
    Returns:
    
    The IDs of the security groups for the target network.
  - vpcId
```
public String vpcId()
```
    The ID of the VPC.
    
    Returns:
    
    The ID of the VPC.
  - toBuilder
```
public ClientVpnEndpoint.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ClientVpnEndpoint.Builder,ClientVpnEndpoint>
  - builder
```
public static ClientVpnEndpoint.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ClientVpnEndpoint.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ClientVpnEndpoint

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

clientVpnEndpointId

description

status

creationTime

deletionTime

dnsName

clientCidrBlock

hasDnsServers

dnsServers

splitTunnel

vpnProtocol

vpnProtocolAsString

transportProtocol

transportProtocolAsString

vpnPort

hasAssociatedTargetNetworks

associatedTargetNetworks

serverCertificateArn

hasAuthenticationOptions

authenticationOptions

connectionLogOptions

hasTags

tags

hasSecurityGroupIds

securityGroupIds

vpcId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields