Package software.amazon.awscdk.services.cognito

Interface CfnUserPoolGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPoolGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-05T03:43:40.817Z")
@Stability(Stable)
public interface CfnUserPoolGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnUserPoolGroup.

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserPoolGroupProps.Builder	A builder for CfnUserPoolGroupProps
static final class	CfnUserPoolGroupProps.Jsii$Proxy	An implementation for CfnUserPoolGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnUserPoolGroupProps.Builder	builder()
default String	getDescription()	A string containing the description of the group.
default String	getGroupName()	The name of the group.
default 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 String	getRoleArn()	The role Amazon Resource Name (ARN) for the group.
String	getUserPoolId()	The user pool ID for the user pool.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getUserPoolId

@Stability(Stable)
@NotNull
String getUserPoolId()

The user pool ID for the user pool.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-userpoolid

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A string containing the description of the group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-description

getGroupName

@Stability(Stable)
@Nullable
default String getGroupName()

The name of the group.

Must be unique.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-groupname

getPrecedence

@Stability(Stable)
@Nullable
default 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.

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-precedence

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

The role Amazon Resource Name (ARN) for the group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolgroup.html#cfn-cognito-userpoolgroup-rolearn

builder

@Stability(Stable)
static CfnUserPoolGroupProps.Builder builder()

Returns:

a CfnUserPoolGroupProps.Builder of CfnUserPoolGroupProps