@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)", date="2022-06-22T23:27:58.797Z") public class CfnUserPoolGroup extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnUserPoolGroup.Builder
A fluent builder for
CfnUserPoolGroup . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnUserPoolGroup(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnUserPoolGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnUserPoolGroup(Construct scope, java.lang.String id, CfnUserPoolGroupProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getUserPoolId()
public void setUserPoolId(java.lang.String value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.String getGroupName()
Must be unique.
public void setGroupName(java.lang.String value)
Must be unique.
public java.lang.Number getPrecedence()
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
.
public void setPrecedence(java.lang.Number value)
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
.
public java.lang.String getRoleArn()
public void setRoleArn(java.lang.String value)