software.amazon.awssdk.services.ec2.model

Class ModifyClientVpnEndpointRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.ModifyClientVpnEndpointRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ModifyClientVpnEndpointRequest.Builder,ModifyClientVpnEndpointRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ModifyClientVpnEndpointRequest
extends Ec2Request
implements ToCopyableBuilder<ModifyClientVpnEndpointRequest.Builder,ModifyClientVpnEndpointRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ModifyClientVpnEndpointRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ModifyClientVpnEndpointRequest.Builder	builder()
ClientConnectOptions	clientConnectOptions() The options for managing connection authorization for new client connections.
ClientLoginBannerOptions	clientLoginBannerOptions() Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
String	clientVpnEndpointId() The ID of the Client VPN endpoint to modify.
ConnectionLogOptions	connectionLogOptions() Information about the client connection logging options.
String	description() A brief description of the Client VPN endpoint.
DnsServersOptionsModifyStructure	dnsServers() Information about the DNS servers to be used by Client VPN connections.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSecurityGroupIds() For responses, this returns true if the service returned a value for the SecurityGroupIds property.
List<SdkField<?>>	sdkFields()
List<String>	securityGroupIds() The IDs of one or more security groups to apply to the target network.
SelfServicePortal	selfServicePortal() Specify whether to enable the self-service portal for the Client VPN endpoint.
String	selfServicePortalAsString() Specify whether to enable the self-service portal for the Client VPN endpoint.
static Class<? extends ModifyClientVpnEndpointRequest.Builder>	serializableBuilderClass()
String	serverCertificateArn() The ARN of the server certificate to be used.
Integer	sessionTimeoutHours() The maximum VPN session duration time in hours.
Boolean	splitTunnel() Indicates whether the VPN is split-tunnel.
ModifyClientVpnEndpointRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	vpcId() The ID of the VPC to associate with the Client VPN endpoint.
Integer	vpnPort() The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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 final String clientVpnEndpointId()

The ID of the Client VPN endpoint to modify.

Returns:

The ID of the Client VPN endpoint to modify.

serverCertificateArn

public final String serverCertificateArn()

The ARN of the server certificate to be used. The server certificate must be provisioned in Certificate Manager (ACM).

Returns:

The ARN of the server certificate to be used. The server certificate must be provisioned in Certificate Manager (ACM).

connectionLogOptions

public final ConnectionLogOptions connectionLogOptions()

Information about the client connection logging options.

If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:

• Client connection requests

• Client connection results (successful and unsuccessful)

• Reasons for unsuccessful client connection requests

• Client connection termination time

Returns:

Information about the client connection logging options.

If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:

• Client connection requests

• Client connection results (successful and unsuccessful)

• Reasons for unsuccessful client connection requests

• Client connection termination time

dnsServers

public final DnsServersOptionsModifyStructure dnsServers()

Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers.

Returns:

Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers.

vpnPort

public final Integer vpnPort()

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

Valid Values: 443 | 1194

Default Value: 443

Returns:

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

Valid Values: 443 | 1194

Default Value: 443

description

public final String description()

A brief description of the Client VPN endpoint.

Returns:

A brief description of the Client VPN endpoint.

splitTunnel

public final Boolean splitTunnel()

Indicates whether the VPN is split-tunnel.

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

Returns:

Indicates whether the VPN is split-tunnel.

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

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 one or more security groups to apply to 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 one or more security groups to apply to the target network.

vpcId

public final String vpcId()

The ID of the VPC to associate with the Client VPN endpoint.

Returns:

The ID of the VPC to associate with the Client VPN endpoint.

selfServicePortal

public final SelfServicePortal selfServicePortal()

Specify whether to enable the self-service portal for the Client VPN endpoint.

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

Returns:

Specify whether to enable the self-service portal for the Client VPN endpoint.

See Also:

SelfServicePortal

selfServicePortalAsString

public final String selfServicePortalAsString()

Specify whether to enable the self-service portal for the Client VPN endpoint.

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

Returns:

Specify whether to enable the self-service portal for the Client VPN endpoint.

See Also:

SelfServicePortal

clientConnectOptions

public final ClientConnectOptions 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 ClientLoginBannerOptions 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 ModifyClientVpnEndpointRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModifyClientVpnEndpointRequest.Builder,ModifyClientVpnEndpointRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static ModifyClientVpnEndpointRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo