Interface AdminSetUserSettingsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CognitoIdentityProviderRequest.Builder
,CopyableBuilder<AdminSetUserSettingsRequest.Builder,
,AdminSetUserSettingsRequest> SdkBuilder<AdminSetUserSettingsRequest.Builder,
,AdminSetUserSettingsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
AdminSetUserSettingsRequest
-
Method Summary
Modifier and TypeMethodDescriptionmfaOptions
(Collection<MFAOptionType> mfaOptions) You can use this parameter only to set an SMS configuration that uses SMS for delivery.mfaOptions
(Consumer<MFAOptionType.Builder>... mfaOptions) You can use this parameter only to set an SMS configuration that uses SMS for delivery.mfaOptions
(MFAOptionType... mfaOptions) You can use this parameter only to set an SMS configuration that uses SMS for delivery.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The username of the user that you want to query or modify.userPoolId
(String userPoolId) The ID of the user pool that contains the user whose options you're setting.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
userPoolId
The ID of the user pool that contains the user whose options you're setting.
- Parameters:
userPoolId
- The ID of the user pool that contains the user whose options you're setting.- 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
username
isn't an alias attribute in your user pool, this value must be thesub
of 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. Ifusername
isn't an alias attribute in your user pool, this value must be thesub
of 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.
-
mfaOptions
You can use this parameter only to set an SMS configuration that uses SMS for delivery.
- Parameters:
mfaOptions
- You can use this parameter only to set an SMS configuration that uses SMS for delivery.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mfaOptions
You can use this parameter only to set an SMS configuration that uses SMS for delivery.
- Parameters:
mfaOptions
- You can use this parameter only to set an SMS configuration that uses SMS for delivery.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mfaOptions
You can use this parameter only to set an SMS configuration that uses SMS for delivery.
This is a convenience method that creates an instance of theMFAOptionType.Builder
avoiding the need to create one manually viaMFAOptionType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomfaOptions(List<MFAOptionType>)
.- Parameters:
mfaOptions
- a consumer that will call methods onMFAOptionType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
AdminSetUserSettingsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
AdminSetUserSettingsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-