Class ModifyClientVpnEndpointAuthorizationPolicyRequest

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.ModifyClientVpnEndpointAuthorizationPolicyRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ModifyClientVpnEndpointAuthorizationPolicyRequest.Builder,ModifyClientVpnEndpointAuthorizationPolicyRequest>
@Generated("software.amazon.awssdk:codegen") public final class ModifyClientVpnEndpointAuthorizationPolicyRequest extends Ec2Request implements ToCopyableBuilder<ModifyClientVpnEndpointAuthorizationPolicyRequest.Builder,ModifyClientVpnEndpointAuthorizationPolicyRequest>

  • Method Details

    • clientVpnEndpointId

      public final String clientVpnEndpointId()

      The ID of the Client VPN endpoint.

      Returns:
      The ID of the Client VPN endpoint.

    • policyDocument

      public final String policyDocument()

      The authorization policy document, written in the Cedar policy language. This parameter is required when you create the authorization policy for a Client VPN endpoint that does not already have one.

      Returns:
      The authorization policy document, written in the Cedar policy language. This parameter is required when you create the authorization policy for a Client VPN endpoint that does not already have one.

    • description

      public final String description()

      A brief description of the authorization policy.

      Returns:
      A brief description of the authorization policy.

    • shadowMode

      public final ClientVpnAuthorizationPolicyShadowMode shadowMode()

      Specifies whether the authorization policy is evaluated in shadow mode. Possible values include:

      • enabled - The authorization policy is evaluated and the results are logged, but access is not enforced.

      • disabled - The authorization policy is enforced.

      The default value is disabled.

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

      Returns:
      Specifies whether the authorization policy is evaluated in shadow mode. Possible values include:

      • enabled - The authorization policy is evaluated and the results are logged, but access is not enforced.

      • disabled - The authorization policy is enforced.

      The default value is disabled.

      See Also:

    • shadowModeAsString

      public final String shadowModeAsString()

      Specifies whether the authorization policy is evaluated in shadow mode. Possible values include:

      • enabled - The authorization policy is evaluated and the results are logged, but access is not enforced.

      • disabled - The authorization policy is enforced.

      The default value is disabled.

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

      Returns:
      Specifies whether the authorization policy is evaluated in shadow mode. Possible values include:

      • enabled - The authorization policy is evaluated and the results are logged, but access is not enforced.

      • disabled - The authorization policy is enforced.

      The default value is disabled.

      See Also:

    • clientToken

      public final String clientToken()

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

      Returns:
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring 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 ModifyClientVpnEndpointAuthorizationPolicyRequest.Builder 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 interface ToCopyableBuilder<ModifyClientVpnEndpointAuthorizationPolicyRequest.Builder,ModifyClientVpnEndpointAuthorizationPolicyRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • builder

      public static ModifyClientVpnEndpointAuthorizationPolicyRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ModifyClientVpnEndpointAuthorizationPolicyRequest.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.