Class AuthorizeClientVpnIngressRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<AuthorizeClientVpnIngressRequest.Builder,
AuthorizeClientVpnIngressRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group.final Boolean
Indicates whether to grant access to all clients.builder()
final String
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.final String
The ID of the Client VPN endpoint.final String
A brief description of the authorization rule.final Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
static Class
<? extends AuthorizeClientVpnIngressRequest.Builder> final String
The IPv4 address range, in CIDR notation, of the network for which access is being authorized.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
clientVpnEndpointId
The ID of the Client VPN endpoint.
- Returns:
- The ID of the Client VPN endpoint.
-
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
The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Required if
AuthorizeAllGroups
isfalse
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
isfalse
or not specified.
-
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 totrue
ifAccessGroupId
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 totrue
ifAccessGroupId
is not specified.
-
description
A brief description of the authorization rule.
- Returns:
- A brief description of the authorization rule.
-
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
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
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 interfaceToCopyableBuilder<AuthorizeClientVpnIngressRequest.Builder,
AuthorizeClientVpnIngressRequest> - Specified by:
toBuilder
in classEc2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-