Group

Source: src/AWS/Cognito/Group.ts

A group within an Amazon Cognito user pool. Groups organize users, appear in the cognito:groups token claim, and can carry an IAM role for identity-pool federation.

Creating Groups

Basic Group

import * as Cognito from "alchemy/AWS/Cognito";

const pool = yield* Cognito.UserPool("Users", {});
const admins = yield* Cognito.Group("Admins", {
  userPoolId: pool.userPoolId,
  description: "Administrators",
});

Group with Role and Precedence

const admins = yield* Cognito.Group("Admins", {
  userPoolId: pool.userPoolId,
  roleArn: role.roleArn,
  precedence: 1,
});