CfnUserPoolGroupProps

class aws_cdk.aws_cognito.CfnUserPoolGroupProps(*, user_pool_id, description=None, group_name=None, precedence=None, role_arn=None)

Bases: object

Properties for defining a CfnUserPoolGroup.

Parameters
  • user_pool_id (str) – The user pool ID for the user pool.

  • description (Optional[str]) – A string containing the description of the group.

  • group_name (Optional[str]) – The name of the group. Must be unique.

  • precedence (Union[int, float, None]) – 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 ornull 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.

  • role_arn (Optional[str]) – The role Amazon Resource Name (ARN) for the group.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_cognito as cognito

cfn_user_pool_group_props = cognito.CfnUserPoolGroupProps(
    user_pool_id="userPoolId",

    # the properties below are optional
    description="description",
    group_name="groupName",
    precedence=123,
    role_arn="roleArn"
)

Attributes

description

A string containing the description of the group.

Link

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

Return type

Optional[str]

group_name

The name of the group.

Must be unique.

Link

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

Return type

Optional[str]

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

Link

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

Return type

Union[int, float, None]

role_arn

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

Link

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

Return type

Optional[str]

user_pool_id

The user pool ID for the user pool.

Link

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

Return type

str