Package software.amazon.awscdk.services.cognito

Class CfnUserPoolGroup.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.CfnUserPoolGroup.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUserPoolGroup>

Enclosing class:

CfnUserPoolGroup

@Stability(Stable)
public static final class CfnUserPoolGroup.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUserPoolGroup>

A fluent builder for CfnUserPoolGroup.

Method Summary

Modifier and Type	Method	Description
CfnUserPoolGroup	build()
static CfnUserPoolGroup.Builder	create(software.constructs.Construct scope, String id)
CfnUserPoolGroup.Builder	description(String description)	A description of the group that you're creating.
CfnUserPoolGroup.Builder	groupName(String groupName)	A name for the group.
CfnUserPoolGroup.Builder	precedence(Number 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.
CfnUserPoolGroup.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group.
CfnUserPoolGroup.Builder	roleArn(IRoleRef roleArn)	The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group.
CfnUserPoolGroup.Builder	userPoolId(String userPoolId)	The ID of the user pool where you want to create a user group.
CfnUserPoolGroup.Builder	userPoolId(IUserPoolRef userPoolId)	The ID of the user pool where you want to create a user group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnUserPoolGroup.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnUserPoolGroup.Builder.

userPoolId

@Stability(Stable)
public CfnUserPoolGroup.Builder userPoolId(String userPoolId)

The ID of the user pool where you want to create a user group.

Parameters:

userPoolId - The ID of the user pool where you want to create a user group. This parameter is required.

Returns:

this

See Also:

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

userPoolId

@Stability(Stable)
public CfnUserPoolGroup.Builder userPoolId(IUserPoolRef userPoolId)

The ID of the user pool where you want to create a user group.

Parameters:

userPoolId - The ID of the user pool where you want to create a user group. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnUserPoolGroup.Builder description(String description)

A description of the group that you're creating.

Parameters:

description - A description of the group that you're creating. This parameter is required.

Returns:

this

See Also:

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

groupName

@Stability(Stable)
public CfnUserPoolGroup.Builder groupName(String groupName)

A name for the group.

This name must be unique in your user pool.

Parameters:

groupName - A name for the group. This parameter is required.

Returns:

this

See Also:

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

precedence

@Stability(Stable)
public CfnUserPoolGroup.Builder precedence(Number 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 .

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. This parameter is required.

Returns:

this

See Also:

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

roleArn

@Stability(Stable)
public CfnUserPoolGroup.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group.

A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a cognito:preferred_role claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a cognito:groups claim that list all the groups that a user is a member of.

Parameters:

roleArn - The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. This parameter is required.

Returns:

this

See Also:

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

roleArn

@Stability(Stable)
public CfnUserPoolGroup.Builder roleArn(IRoleRef roleArn)

The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group.

A group role primarily declares a preferred role for the credentials that you get from an identity pool. Amazon Cognito ID tokens have a cognito:preferred_role claim that presents the highest-precedence group that a user belongs to. Both ID and access tokens also contain a cognito:groups claim that list all the groups that a user is a member of.

Parameters:

roleArn - The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnUserPoolGroup build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnUserPoolGroup>

Returns:

a newly built instance of CfnUserPoolGroup.