public static final class CfnUserPoolGroupProps.Builder
extends java.lang.Object
CfnUserPoolGroupProps
Constructor and Description |
---|
Builder() |
Modifier and Type | Method and Description |
---|---|
CfnUserPoolGroupProps |
build()
Builds the configured instance.
|
CfnUserPoolGroupProps.Builder |
description(java.lang.String description)
Sets the value of
CfnUserPoolGroupProps.getDescription() |
CfnUserPoolGroupProps.Builder |
groupName(java.lang.String groupName)
Sets the value of
CfnUserPoolGroupProps.getGroupName() |
CfnUserPoolGroupProps.Builder |
precedence(java.lang.Number precedence)
Sets the value of
CfnUserPoolGroupProps.getPrecedence() |
CfnUserPoolGroupProps.Builder |
roleArn(java.lang.String roleArn)
Sets the value of
CfnUserPoolGroupProps.getRoleArn() |
CfnUserPoolGroupProps.Builder |
userPoolId(java.lang.String userPoolId)
Sets the value of
CfnUserPoolGroupProps.getUserPoolId() |
public CfnUserPoolGroupProps.Builder userPoolId(java.lang.String userPoolId)
CfnUserPoolGroupProps.getUserPoolId()
userPoolId
- The user pool ID for the user pool. This parameter is required.this
public CfnUserPoolGroupProps.Builder description(java.lang.String description)
CfnUserPoolGroupProps.getDescription()
description
- A string containing the description of the group.this
public CfnUserPoolGroupProps.Builder groupName(java.lang.String groupName)
CfnUserPoolGroupProps.getGroupName()
groupName
- The name of the group.
Must be unique.this
public CfnUserPoolGroupProps.Builder precedence(java.lang.Number precedence)
CfnUserPoolGroupProps.getPrecedence()
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 null Precedence
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 the cognito:roles
and cognito: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 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 isn't set in users' tokens.
The default Precedence
value is null. The maximum Precedence
value is 2^31-1
.
this
public CfnUserPoolGroupProps.Builder roleArn(java.lang.String roleArn)
CfnUserPoolGroupProps.getRoleArn()
roleArn
- The role Amazon Resource Name (ARN) for the group.this
public CfnUserPoolGroupProps build()
CfnUserPoolGroupProps
java.lang.NullPointerException
- if any required attribute was not provided