Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class AdminDisableUserRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest
software.amazon.awssdk.services.cognitoidentityprovider.model.AdminDisableUserRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<AdminDisableUserRequest.Builder,AdminDisableUserRequest>
@Generated("software.amazon.awssdk:codegen") public final class AdminDisableUserRequest extends CognitoIdentityProviderRequest implements ToCopyableBuilder<AdminDisableUserRequest.Builder,AdminDisableUserRequest>

Represents the request to disable the user as an administrator.

  • Method Details

    • userPoolId

      public final String userPoolId()

      The ID of the user pool where you want to disable the user.

      Returns:
      The ID of the user pool where you want to disable the user.

    • username

      public final String username()

      The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

      Returns:
      The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

    • toBuilder

      public AdminDisableUserRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<AdminDisableUserRequest.Builder,AdminDisableUserRequest>
      Specified by:
      toBuilder in class CognitoIdentityProviderRequest

    • builder

      public static AdminDisableUserRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo