interface IUserPoolGroup

Language	Type name
.NET	Amazon.CDK.AWS.Cognito.IUserPoolGroup
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscognito#IUserPoolGroup
Java	software.amazon.awscdk.services.cognito.IUserPoolGroup
Python	aws_cdk.aws_cognito.IUserPoolGroup
TypeScript (source)	aws-cdk-lib » aws_cognito » IUserPoolGroup

Implemented by UserPoolGroup

Obtainable from UserPoolGroup.fromGroupName()

Represents a user pool group.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
groupName	string	The user group name.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

groupName

Type: string

The user group name.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

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