@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-22T19:35:46.804Z")
public interface CfnUserPoolGroupProps
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.cognito.*; CfnUserPoolGroupProps cfnUserPoolGroupProps = CfnUserPoolGroupProps.builder() .userPoolId("userPoolId") // the properties below are optional .description("description") .groupName("groupName") .precedence(123) .roleArn("roleArn") .build();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnUserPoolGroupProps.Builder
A builder for
CfnUserPoolGroupProps |
static class |
CfnUserPoolGroupProps.Jsii$Proxy
An implementation for
CfnUserPoolGroupProps |
Modifier and Type | Method and Description |
---|---|
static CfnUserPoolGroupProps.Builder |
builder() |
default java.lang.String |
getDescription()
A string containing the description of the group.
|
default java.lang.String |
getGroupName()
The name of the group.
|
default java.lang.Number |
getPrecedence()
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.
|
default java.lang.String |
getRoleArn()
The role Amazon Resource Name (ARN) for the group.
|
java.lang.String |
getUserPoolId()
The user pool ID for the user pool.
|
java.lang.String getUserPoolId()
default java.lang.String getDescription()
default java.lang.String getGroupName()
Must be unique.
default java.lang.Number getPrecedence()
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
.
default java.lang.String getRoleArn()
static CfnUserPoolGroupProps.Builder builder()
CfnUserPoolGroupProps.Builder
of CfnUserPoolGroupProps