Class TerminateClientVpnConnectionsRequest
- 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.TerminateClientVpnConnectionsRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<TerminateClientVpnConnectionsRequest.Builder,TerminateClientVpnConnectionsRequest>
@Generated("software.amazon.awssdk:codegen") public final class TerminateClientVpnConnectionsRequest extends Ec2Request implements ToCopyableBuilder<TerminateClientVpnConnectionsRequest.Builder,TerminateClientVpnConnectionsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
TerminateClientVpnConnectionsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static TerminateClientVpnConnectionsRequest.Builder
builder()
String
clientVpnEndpointId()
The ID of the Client VPN endpoint to which the client is connected.String
connectionId()
The ID of the client connection to be terminated.Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
List<SdkField<?>>
sdkFields()
static Class<? extends TerminateClientVpnConnectionsRequest.Builder>
serializableBuilderClass()
TerminateClientVpnConnectionsRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
username()
The name of the user who initiated the connection.-
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 which the client is connected.
- Returns:
- The ID of the Client VPN endpoint to which the client is connected.
-
connectionId
public final String connectionId()
The ID of the client connection to be terminated.
- Returns:
- The ID of the client connection to be terminated.
-
username
public final String username()
The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user has established up to five connections.
- Returns:
- The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user has established up to five connections.
-
dryRun
public final Boolean dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Checks whether you have the required permissions for the action, without actually making the request, and
provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.
-
toBuilder
public TerminateClientVpnConnectionsRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<TerminateClientVpnConnectionsRequest.Builder,TerminateClientVpnConnectionsRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static TerminateClientVpnConnectionsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends TerminateClientVpnConnectionsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-