UserPoolGroup

class aws_cdk.aws_cognito.UserPoolGroup(scope, id, *, user_pool, description=None, group_name=None, precedence=None, role=None)

Bases: Resource

Define a user pool group.

ExampleMetadata:: infused

Example:

# user_pool: cognito.UserPool
# role: iam.Role


cognito.UserPoolGroup(self, "UserPoolGroup",
    user_pool=user_pool,
    group_name="my-group-name",
    precedence=1,
    role=role
)

# You can also add a group by using addGroup method.
user_pool.add_group("AnotherUserPoolGroup",
    group_name="another-group-name"
)

Parameters:

scope (Construct) –
id (str) –
user_pool (IUserPool) – The user pool to which this group is associated.
description (Optional[str]) – A string containing the description of the group. Default: - no description
group_name (Optional[str]) – The name of the group. Must be unique. Default: - auto generate a name
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 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. Default: - null
role (Optional[IRole]) – The role for the group. Default: - no description

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

group_name: The user group name.

node: The tree node.

stack: The stack in which this resource is defined.

Static Methods

classmethod from_group_name(scope, id, group_name)

Import a UserPoolGroup given its group name.

Parameters:

scope (Construct) –
id (str) –
group_name (str) –

Return type:

IUserPoolGroup

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool