Interface UpdateGroupRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CognitoIdentityProviderRequest.Builder,CopyableBuilder<UpdateGroupRequest.Builder,,UpdateGroupRequest> SdkBuilder<UpdateGroupRequest.Builder,,UpdateGroupRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
UpdateGroupRequest
public static interface UpdateGroupRequest.Builder
extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<UpdateGroupRequest.Builder,UpdateGroupRequest>
-
Method Summary
Modifier and TypeMethodDescriptiondescription(String description) A string containing the new description of the group.The name of the group.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.precedence(Integer precedence) The new precedence value for the group.The new role Amazon Resource Name (ARN) for the group.userPoolId(String userPoolId) The user pool ID for the user pool.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
-
groupName
The name of the group.
- Parameters:
groupName- The name of the group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userPoolId
The user pool ID for the user pool.
- Parameters:
userPoolId- The user pool ID for the user pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
A string containing the new description of the group.
- Parameters:
description- A string containing the new description of the group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
roleArn
The new role Amazon Resource Name (ARN) for the group. This is used for setting the
cognito:rolesandcognito:preferred_roleclaims in the token.- Parameters:
roleArn- The new role Amazon Resource Name (ARN) for the group. This is used for setting thecognito:rolesandcognito:preferred_roleclaims in the token.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
precedence
The new precedence value for the group. For more information about this parameter, see CreateGroup.
- Parameters:
precedence- The new precedence value for the group. For more information about this parameter, see CreateGroup.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
UpdateGroupRequest.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
UpdateGroupRequest.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.
-