Create Group (v1.0.0)

Command that will create a group and in Cognito and PAL.

Overview

This command in the IAM adapter, can be used to create a new group. The group can be used as assigning different roles or separating users. It is up to the application to decide what membership of a group means. There are also ways in Cognito to use groups and assign IAM roles. But that is out of scope for this adapter.

Architecture diagram

Payload example

Request

Payload example
{
"GroupName": "Admins",
"Description": "Group for admin users",
"UserPoolId": "us-east-1_examplepool",
"Precedence": null,
"RoleArn": null,
"Attributes": {
}
}

JSON Schema

6 properties
GroupName string
required

Name of the group

Description stringnull

Description of the group

UserPoolId stringnull

User pool id, required if there are multiple PoolId:s

Precedence integernull

Precedence of the group. AWS Cognito Attribute.

RoleArn stringnull

Role ARN for the group. AWS Cognito Attribute.

Attributes object → Attributes