Class UpdateLoginProfileRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateLoginProfileRequest.Builder,UpdateLoginProfileRequest>

@Generated("software.amazon.awssdk:codegen") public final class UpdateLoginProfileRequest extends IamRequest implements ToCopyableBuilder<UpdateLoginProfileRequest.Builder,UpdateLoginProfileRequest>
  • Method Details

    • userName

      public final String userName()

      The name of the user whose password you want to update.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

      Returns:
      The name of the user whose password you want to update.

      This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

    • password

      public final String password()

      The new password for the specified IAM user.

      The regex pattern used to validate this parameter is a string of characters consisting of the following:

      • Any printable ASCII character ranging from the space character ( ) through the end of the ASCII character range

      • The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)

      • The special characters tab ( ), line feed ( ), and carriage return ( )

      However, the format can be further restricted by the account administrator by setting a password policy on the Amazon Web Services account. For more information, see UpdateAccountPasswordPolicy.

      Returns:
      The new password for the specified IAM user.

      The regex pattern used to validate this parameter is a string of characters consisting of the following:

      • Any printable ASCII character ranging from the space character ( ) through the end of the ASCII character range

      • The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)

      • The special characters tab ( ), line feed ( ), and carriage return ( )

      However, the format can be further restricted by the account administrator by setting a password policy on the Amazon Web Services account. For more information, see UpdateAccountPasswordPolicy.

    • passwordResetRequired

      public final Boolean passwordResetRequired()

      Allows this new password to be used only once by requiring the specified IAM user to set a new password on next sign-in.

      Returns:
      Allows this new password to be used only once by requiring the specified IAM user to set a new password on next sign-in.
    • maxSigninSessionDuration

      public final Integer maxSigninSessionDuration()

      The maximum duration (in seconds) of an Amazon Web Services Sign-In session for the specified IAM user. This setting can have a value from 1 hour (3600 seconds) to 90 days (7776000 seconds), inclusive, and replaces any value currently configured for the user.

      If you omit both this parameter and ResetMaxSigninSessionDuration, the current setting is unchanged. You cannot specify this parameter and set ResetMaxSigninSessionDuration to true in the same request. If you update only the sign-in session duration, the user's password and PasswordResetRequired setting do not change.

      Changes to this setting apply to new sign-in sessions. Sessions that are already established are not affected.

      This setting is not supported for the root user.

      Returns:
      The maximum duration (in seconds) of an Amazon Web Services Sign-In session for the specified IAM user. This setting can have a value from 1 hour (3600 seconds) to 90 days (7776000 seconds), inclusive, and replaces any value currently configured for the user.

      If you omit both this parameter and ResetMaxSigninSessionDuration, the current setting is unchanged. You cannot specify this parameter and set ResetMaxSigninSessionDuration to true in the same request. If you update only the sign-in session duration, the user's password and PasswordResetRequired setting do not change.

      Changes to this setting apply to new sign-in sessions. Sessions that are already established are not affected.

      This setting is not supported for the root user.

    • resetMaxSigninSessionDuration

      public final Boolean resetMaxSigninSessionDuration()

      Specifies whether to clear the maximum sign-in session duration for the specified IAM user. Set this value to true to return the setting to its unset state, so that the existing sign-in session behavior applies. When the setting is unset, the user's MaxSigninSessionDuration is omitted from responses.

      If you set this value to false or omit it, the current setting is not cleared. You cannot set this value to true and specify MaxSigninSessionDuration in the same request. Clearing a setting that is already unset has no effect.

      Returns:
      Specifies whether to clear the maximum sign-in session duration for the specified IAM user. Set this value to true to return the setting to its unset state, so that the existing sign-in session behavior applies. When the setting is unset, the user's MaxSigninSessionDuration is omitted from responses.

      If you set this value to false or omit it, the current setting is not cleared. You cannot set this value to true and specify MaxSigninSessionDuration in the same request. Clearing a setting that is already unset has no effect.

    • 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<UpdateLoginProfileRequest.Builder,UpdateLoginProfileRequest>
      Specified by:
      toBuilder in class IamRequest
      Returns:
      a builder for type T
    • builder

      public static UpdateLoginProfileRequest.Builder builder()
    • serializableBuilderClass

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