Interface CreateGroupRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CognitoIdentityProviderRequest.Builder
,CopyableBuilder<CreateGroupRequest.Builder,
,CreateGroupRequest> SdkBuilder<CreateGroupRequest.Builder,
,CreateGroupRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateGroupRequest
-
Method Summary
Modifier and TypeMethodDescriptiondescription
(String description) A string containing the 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) A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool.The 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
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
-
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
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 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
The role Amazon Resource Name (ARN) for the group.
- Parameters:
roleArn
- The role Amazon Resource Name (ARN) for the group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
precedence
A non-negative 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 nullPrecedence
values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for thecognito:roles
andcognito:preferred_role
claims.Two groups can have the same
Precedence
value. If this happens, neither group takes precedence over the other. If two groups with the samePrecedence
have the same role ARN, that role is used in thecognito:preferred_role
claim in tokens for users in each group. If the two groups have different role ARNs, thecognito:preferred_role
claim isn't set in users' tokens.The default
Precedence
value is null. The maximumPrecedence
value is2^31-1
.- Parameters:
precedence
- A non-negative 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 lowerPrecedence
values take precedence over groups with higher or nullPrecedence
values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for thecognito:roles
andcognito:preferred_role
claims.Two groups can have the same
Precedence
value. If this happens, neither group takes precedence over the other. If two groups with the samePrecedence
have the same role ARN, that role is used in thecognito:preferred_role
claim in tokens for users in each group. If the two groups have different role ARNs, thecognito:preferred_role
claim isn't set in users' tokens.The default
Precedence
value is null. The maximumPrecedence
value is2^31-1
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateGroupRequest.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
CreateGroupRequest.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.
-