software.amazon.awssdk.services.cognitoidentityprovider.model

Interface CreateGroupRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CognitoIdentityProviderRequest.Builder, CopyableBuilder<CreateGroupRequest.Builder,CreateGroupRequest>, SdkBuilder<CreateGroupRequest.Builder,CreateGroupRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateGroupRequest

public static interface CreateGroupRequest.Builder
extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<CreateGroupRequest.Builder,CreateGroupRequest>

Method Summary

Modifier and Type	Method and Description
CreateGroupRequest.Builder	description(String description) A string containing the description of the group.
CreateGroupRequest.Builder	groupName(String groupName) The name of the group.
CreateGroupRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateGroupRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateGroupRequest.Builder	precedence(Integer precedence) A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool.
CreateGroupRequest.Builder	roleArn(String roleArn) The role ARN for the group.
CreateGroupRequest.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

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

groupName

CreateGroupRequest.Builder groupName(String groupName)

The name of the group. Must be unique.

Parameters:

groupName - The name of the group. Must be unique.

Returns:

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

userPoolId

CreateGroupRequest.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

CreateGroupRequest.Builder description(String description)

A string containing the description of the group.

Parameters:

description - A string containing the description of the group.

Returns:

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

roleArn

CreateGroupRequest.Builder roleArn(String roleArn)

The role ARN for the group.

Parameters:

roleArn - The role ARN for the group.

Returns:

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

precedence

CreateGroupRequest.Builder precedence(Integer precedence)

A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim is not set in users' tokens.

The default Precedence value is null.

Parameters:

precedence - A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim is not set in users' tokens.

The default Precedence value is null.

Returns:

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

overrideConfiguration

CreateGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder