Interface AdminDeleteUserAttributesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CognitoIdentityProviderRequest.Builder
,CopyableBuilder<AdminDeleteUserAttributesRequest.Builder,
,AdminDeleteUserAttributesRequest> SdkBuilder<AdminDeleteUserAttributesRequest.Builder,
,AdminDeleteUserAttributesRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
AdminDeleteUserAttributesRequest
-
Method Summary
Modifier and TypeMethodDescriptionoverrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.userAttributeNames
(String... userAttributeNames) An array of strings representing the user attribute names you want to delete.userAttributeNames
(Collection<String> userAttributeNames) An array of strings representing the user attribute names you want to delete.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 delete user attributes.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 user pool ID for the user pool where you want to delete user attributes.
- Parameters:
userPoolId
- The user pool ID for the user pool where you want to delete user attributes.- 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.
-
userAttributeNames
An array of strings representing the user attribute names you want to delete.
For custom attributes, you must prepend the
custom:
prefix to the attribute name.- Parameters:
userAttributeNames
- An array of strings representing the user attribute names you want to delete.For custom attributes, you must prepend the
custom:
prefix to the attribute name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userAttributeNames
An array of strings representing the user attribute names you want to delete.
For custom attributes, you must prepend the
custom:
prefix to the attribute name.- Parameters:
userAttributeNames
- An array of strings representing the user attribute names you want to delete.For custom attributes, you must prepend the
custom:
prefix to the attribute name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
AdminDeleteUserAttributesRequest.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
AdminDeleteUserAttributesRequest.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.
-