software.amazon.awscdk.services.cognito

Class CfnUserPoolGroup

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.cognito.CfnUserPoolGroup

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:27:58.797Z")
public class CfnUserPoolGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Cognito::UserPoolGroup`.

Specifies a new group in the identified user pool.

Calling this action requires developer credentials.

If you don't specify a value for a parameter, Amazon Cognito sets it to a default value.

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.*;
 CfnUserPoolGroup cfnUserPoolGroup = CfnUserPoolGroup.Builder.create(this, "MyCfnUserPoolGroup")
         .userPoolId("userPoolId")
         // the properties below are optional
         .description("description")
         .groupName("groupName")
         .precedence(123)
         .roleArn("roleArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnUserPoolGroup.Builder A fluent builder for CfnUserPoolGroup.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnUserPoolGroup(Construct scope, java.lang.String id, CfnUserPoolGroupProps props) Create a new `AWS::Cognito::UserPoolGroup`.
protected	CfnUserPoolGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUserPoolGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() A string containing the description of the group.
java.lang.String	getGroupName() The name of the group.
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.
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.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDescription(java.lang.String value) A string containing the description of the group.
void	setGroupName(java.lang.String value) The name of the group.
void	setPrecedence(java.lang.Number value) 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.
void	setRoleArn(java.lang.String value) The role Amazon Resource Name (ARN) for the group.
void	setUserPoolId(java.lang.String value) The user pool ID for the user pool.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnUserPoolGroup

protected CfnUserPoolGroup(software.amazon.jsii.JsiiObjectRef objRef)

CfnUserPoolGroup

protected CfnUserPoolGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnUserPoolGroup

public CfnUserPoolGroup(Construct scope,
                        java.lang.String id,
                        CfnUserPoolGroupProps props)

Create a new `AWS::Cognito::UserPoolGroup`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getUserPoolId

public java.lang.String getUserPoolId()

The user pool ID for the user pool.

setUserPoolId

public void setUserPoolId(java.lang.String value)

The user pool ID for the user pool.

getDescription

public java.lang.String getDescription()

A string containing the description of the group.

setDescription

public void setDescription(java.lang.String value)

A string containing the description of the group.

getGroupName

public java.lang.String getGroupName()

The name of the group.

Must be unique.

setGroupName

public void setGroupName(java.lang.String value)

The name of the group.

Must be unique.

getPrecedence

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

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 .

setPrecedence

public void setPrecedence(java.lang.Number value)

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 .

getRoleArn

public java.lang.String getRoleArn()

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

setRoleArn

public void setRoleArn(java.lang.String value)

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