software.amazon.awscdk.services.cognito

Class CfnUserPoolGroupProps.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.CfnUserPoolGroupProps.Builder

Enclosing interface:

CfnUserPoolGroupProps

public static final class CfnUserPoolGroupProps.Builder
extends java.lang.Object

A builder for CfnUserPoolGroupProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

userPoolId

public CfnUserPoolGroupProps.Builder userPoolId(java.lang.String userPoolId)

Sets the value of CfnUserPoolGroupProps.getUserPoolId()

Parameters:

userPoolId - The user pool ID for the user pool. This parameter is required.

Returns:

this

description

public CfnUserPoolGroupProps.Builder description(java.lang.String description)

Sets the value of CfnUserPoolGroupProps.getDescription()

Parameters:

description - A string containing the description of the group.

Returns:

this

groupName

public CfnUserPoolGroupProps.Builder groupName(java.lang.String groupName)

Sets the value of CfnUserPoolGroupProps.getGroupName()

Parameters:

groupName - The name of the group. Must be unique.

Returns:

this

precedence

public CfnUserPoolGroupProps.Builder precedence(java.lang.Number precedence)

Sets the value of CfnUserPoolGroupProps.getPrecedence()

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 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 .

Returns:

this

roleArn

public CfnUserPoolGroupProps.Builder roleArn(java.lang.String roleArn)

Sets the value of CfnUserPoolGroupProps.getRoleArn()

Parameters:

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

Returns:

this

build

public CfnUserPoolGroupProps build()

Builds the configured instance.

Returns:

a new instance of CfnUserPoolGroupProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided