Class CreateLoginProfileRequest

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

  • Method Details

    • userName

      public final String userName()

      The name of the IAM user to create a password for. The user must already exist.

      This parameter is optional. If no user name is included, it defaults to the principal making the request. When you make this request with root user credentials, you must use an AssumeRoot session to omit the user name.

      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 IAM user to create a password for. The user must already exist.

      This parameter is optional. If no user name is included, it defaults to the principal making the request. When you make this request with root user credentials, you must use an AssumeRoot session to omit the user name.

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

      This parameter must be omitted when you make the request with an AssumeRoot session. It is required in all other cases.

      The regex pattern that is used to validate this parameter is a string of characters. That string can include almost any printable ASCII character from the space ( ) through the end of the ASCII character range (ÿ). You can also include the tab ( ), line feed ( ), and carriage return ( ) characters. Any of these characters are valid in a password. However, many tools, such as the Amazon Web Services Management Console, might restrict the ability to type certain characters because they have special meaning within that tool.

      Returns:
      The new password for the user.

      This parameter must be omitted when you make the request with an AssumeRoot session. It is required in all other cases.

      The regex pattern that is used to validate this parameter is a string of characters. That string can include almost any printable ASCII character from the space ( ) through the end of the ASCII character range (ÿ). You can also include the tab ( ), line feed ( ), and carriage return ( ) characters. Any of these characters are valid in a password. However, many tools, such as the Amazon Web Services Management Console, might restrict the ability to type certain characters because they have special meaning within that tool.

    • passwordResetRequired

      public final Boolean passwordResetRequired()

      Specifies whether the user is required to set a new password on next sign-in.

      Returns:
      Specifies whether the user is required to set a new password on next sign-in.

    • toBuilder

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

    • builder

      public static CreateLoginProfileRequest.Builder builder()

    • serializableBuilderClass

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