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

Class AuthorizeClientVpnIngressRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AuthorizeClientVpnIngressRequest.Builder,AuthorizeClientVpnIngressRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AuthorizeClientVpnIngressRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	accessGroupId()	The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.
Boolean	authorizeAllGroups()	Indicates whether to grant access to all clients.
static AuthorizeClientVpnIngressRequest.Builder	builder()
String	clientToken()	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	clientVpnEndpointId()	The ID of the Client VPN endpoint.
String	description()	A brief description of the authorization rule.
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 AuthorizeClientVpnIngressRequest.Builder>	serializableBuilderClass()
String	targetNetworkCidr()	The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
AuthorizeClientVpnIngressRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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.

Returns:

The ID of the Client VPN endpoint.

targetNetworkCidr

public final String targetNetworkCidr()

The IPv4 address range, in CIDR notation, of the network for which access is being authorized.

Returns:

The IPv4 address range, in CIDR notation, of the network for which access is being authorized.

accessGroupId

public final String accessGroupId()

The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Required if AuthorizeAllGroups is false or not specified.

Returns:

The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Required if AuthorizeAllGroups is false or not specified.

authorizeAllGroups

public final Boolean authorizeAllGroups()

Indicates whether to grant access to all clients. Specify true to grant all clients who successfully establish a VPN connection access to the network. Must be set to true if AccessGroupId is not specified.

Returns:

Indicates whether to grant access to all clients. Specify true to grant all clients who successfully establish a VPN connection access to the network. Must be set to true if AccessGroupId is not specified.

description

public final String description()

A brief description of the authorization rule.

Returns:

A brief description of the authorization rule.

clientToken

public final String clientToken()

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

Returns:

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

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 is UnauthorizedOperation.

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 is UnauthorizedOperation.

toBuilder

public AuthorizeClientVpnIngressRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AuthorizeClientVpnIngressRequest.Builder,AuthorizeClientVpnIngressRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static AuthorizeClientVpnIngressRequest.Builder builder()

serializableBuilderClass

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