Package software.amazon.awscdk.services.cognito

Class CfnUserPoolGroupProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cognito.CfnUserPoolGroupProps.Jsii$Proxy

All Implemented Interfaces:

CfnUserPoolGroupProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnUserPoolGroupProps

@Stability(Stable)
@Internal
public static final class CfnUserPoolGroupProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnUserPoolGroupProps

An implementation for CfnUserPoolGroupProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.CfnUserPoolGroupProps

CfnUserPoolGroupProps.Builder, CfnUserPoolGroupProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnUserPoolGroupProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnUserPoolGroupProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getDescription()	A description of the group that you're creating.
final String	getGroupName()	A name for the group.
final 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.
final String	getRoleArn()	The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group.
final String	getUserPoolId()	The ID of the user pool where you want to create a user group.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnUserPoolGroupProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnUserPoolGroupProps.Builder.

Method Details

getUserPoolId

public final String getUserPoolId()

Description copied from interface: CfnUserPoolGroupProps

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

Specified by:

getUserPoolId in interface CfnUserPoolGroupProps

See Also:

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

getDescription

public final String getDescription()

Description copied from interface: CfnUserPoolGroupProps

A description of the group that you're creating.

Specified by:

getDescription in interface CfnUserPoolGroupProps

See Also:

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

getGroupName

public final String getGroupName()

Description copied from interface: CfnUserPoolGroupProps

A name for the group.

This name must be unique in your user pool.

Specified by:

getGroupName in interface CfnUserPoolGroupProps

See Also:

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

getPrecedence

public final Number getPrecedence()

Description copied from interface: CfnUserPoolGroupProps

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 .

Specified by:

getPrecedence in interface CfnUserPoolGroupProps

See Also:

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

getRoleArn

public final String getRoleArn()

Description copied from interface: CfnUserPoolGroupProps

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.

Specified by:

getRoleArn in interface CfnUserPoolGroupProps

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object