Interface AdminSetUserPasswordRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CognitoIdentityProviderRequest.Builder,CopyableBuilder<AdminSetUserPasswordRequest.Builder,,AdminSetUserPasswordRequest> SdkBuilder<AdminSetUserPasswordRequest.Builder,,AdminSetUserPasswordRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
AdminSetUserPasswordRequest
public static interface AdminSetUserPasswordRequest.Builder
extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<AdminSetUserPasswordRequest.Builder,AdminSetUserPasswordRequest>
-
Method Summary
Modifier and TypeMethodDescriptionoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The password for the user.Trueif the password is permanent,Falseif it is temporary.The username of the user that you want to query or modify.userPoolId(String userPoolId) The user pool ID for the user pool where you want to set the user's password.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
userPoolId
The user pool ID for the user pool where you want to set the user's password.
- Parameters:
userPoolId- The user pool ID for the user pool where you want to set the user's password.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
username
The username 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
usernameisn't an alias attribute in your user pool, this value must be thesubof a local user or the username of a user from a third-party IdP.- Parameters:
username- The username 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. Ifusernameisn't an alias attribute in your user pool, this value must be thesubof a local user or the username of a user from a third-party IdP.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
password
The password for the user.
- Parameters:
password- The password for the user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
permanent
Trueif the password is permanent,Falseif it is temporary.- Parameters:
permanent-Trueif the password is permanent,Falseif it is temporary.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
AdminSetUserPasswordRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
AdminSetUserPasswordRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-