software.amazon.awssdk.services.cognitoidentityprovider.model

Interface UpdateGroupRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CognitoIdentityProviderRequest.Builder, CopyableBuilder<UpdateGroupRequest.Builder,UpdateGroupRequest>, SdkBuilder<UpdateGroupRequest.Builder,UpdateGroupRequest>, SdkRequest.Builder

Enclosing class:

UpdateGroupRequest

public static interface UpdateGroupRequest.Builder
extends CognitoIdentityProviderRequest.Builder, CopyableBuilder<UpdateGroupRequest.Builder,UpdateGroupRequest>

Method Summary

Modifier and Type	Method and Description
UpdateGroupRequest.Builder	description(String description) A string containing the new description of the group.
UpdateGroupRequest.Builder	groupName(String groupName) The name of the group.
UpdateGroupRequest.Builder	precedence(Integer precedence) The new precedence value for the group.
UpdateGroupRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
UpdateGroupRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
UpdateGroupRequest.Builder	roleArn(String roleArn) The new role ARN for the group.
UpdateGroupRequest.Builder	userPoolId(String userPoolId) The user pool ID for the user pool.

Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

groupName

UpdateGroupRequest.Builder groupName(String 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

UpdateGroupRequest.Builder userPoolId(String 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

UpdateGroupRequest.Builder description(String 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

UpdateGroupRequest.Builder roleArn(String roleArn)

The new role ARN for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

Parameters:

roleArn - The new role ARN for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

Returns:

Returns a reference to this object so that method calls can be chained together.

precedence

UpdateGroupRequest.Builder precedence(Integer 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.

requestOverrideConfig

UpdateGroupRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

UpdateGroupRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.