software.amazon.awscdk.services.cognito

Class CfnUserPoolGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.cognito.CfnUserPoolGroup

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.638Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnUserPoolGroup(software.constructs.Construct scope, 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 Map<String,Object>	getCfnProperties()
String	getDescription() A string containing the description of the group.
String	getGroupName() The name of the group.
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.
String	getRoleArn() The role Amazon Resource Name (ARN) for the group.
String	getUserPoolId() The user pool ID for the user pool.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) A string containing the description of the group.
void	setGroupName(String value) The name of the group.
void	setPrecedence(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(String value) The role Amazon Resource Name (ARN) for the group.
void	setUserPoolId(String value) The user pool ID for the user pool.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnUserPoolGroup(@NotNull
                                                 software.constructs.Construct scope,
                                                 @NotNull
                                                 String id,
                                                 @NotNull
                                                 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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getUserPoolId

@Stability(value=Stable)
 @NotNull
public String getUserPoolId()

The user pool ID for the user pool.

setUserPoolId

@Stability(value=Stable)
public void setUserPoolId(@NotNull
                                                   String value)

The user pool ID for the user pool.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A string containing the description of the group.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A string containing the description of the group.

getGroupName

@Stability(value=Stable)
 @Nullable
public String getGroupName()

The name of the group.

Must be unique.

setGroupName

@Stability(value=Stable)
public void setGroupName(@Nullable
                                                  String value)

The name of the group.

Must be unique.

getPrecedence

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setPrecedence(@Nullable
                                                   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

@Stability(value=Stable)
 @Nullable
public String getRoleArn()

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

setRoleArn

@Stability(value=Stable)
public void setRoleArn(@Nullable
                                                String value)

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