Package software.amazon.awssdk.services.iam.model

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()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateLoginProfileRequest.Builder,CreateLoginProfileRequest>
      Specified by:
      toBuilder in class IamRequest

    • 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)
      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