AWS Cognito Users
Fetches users from a specific user pool in AWS Cognito.
Sync Type: Full Synchronisation
Details
AWS Cognito is a user identity and access management service that lets you add user sign-up, sign-in, and access control to your web and mobile apps. This input connector retrieves user information from a specified Cognito User Pool, allowing you to monitor and analyze user accounts, their status, and attributes.
Functionality
On each sync, Monad connects to the specified AWS Cognito User Pool in the configured region and re-lists every user in the pool, paging through the results automatically.
Every user is emitted again on each sync; the input does not track which users it has already sent.
The connector supports an optional filter on one standard attribute (username, email, phone_number, name, given_name, family_name, preferred_username, cognito:user_status, status or sub).
Custom attributes cannot be used in the filter.
Requirements
- IAM Role Assumption / Static Credentials
- Example permission to attach to the role/user:
Code
Configuration
The following configuration defines the input parameters. Each field's specifications, such as type, requirements, and descriptions, are detailed below.
Settings
| Setting | Type | Required | Default | Description |
|---|---|---|---|---|
cron | string (cron) | Yes | 0 * * * * | Cron string for scheduling the ingest of your input. eg: 0 0 * * * - Daily at midnight, or */15 * * * * - Every 15 minutes. Defaults to an hour. |
role_arn | string | No | - | The ARN of the IAM role to assume for accessing AWS resources. |
region | string | Yes | us-east-1 | The AWS region to use. Allowed values: us-east-1, us-east-2, us-west-1, us-west-2, af-south-1, ap-east-1, ap-south-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-southeast-1, ap-southeast-2, ca-central-1, ca-west-1, cn-north-1, cn-northwest-1, eu-central-1, eu-west-1, eu-west-2, eu-west-3, eu-north-1, eu-south-1, me-south-1, sa-east-1, us-gov-east-1, us-gov-west-1. |
filter | object | No | - | Optional filter for ListUsers API. |
filter.attribute | string | No | - | The attribute to filter on (e.g., 'cognitousername, email, phone_number, name, given_name, family_name, preferred_username, cognito:user_status, status, sub. |
filter.operator | string | No | - | The operator to use for filtering. Allowed values: =, ^=. |
filter.value | string | No | - | The value to filter by (e.g., 'CONFIRMED'). |
user_pool_id | string | Yes | - | AWS Cognito User Pool ID to extract users from |
use_synthetic_data | bool | No | false | Generate synthetic data for testing, instead of connecting to a real data source. Defaults to an hourly cron schedule for cron-based inputs. |
Filter Object Properties
| Setting | Type | Required | Description |
|---|---|---|---|
| Attribute | string | No | The attribute to filter on (e.g., 'cognito |
| Value | string | No | The value to filter by (e.g., 'CONFIRMED'). |
| Operator | string | No | The operator to use for filtering. |
The filter is all-or-nothing: if you set any of Attribute, Value or Operator, all three are required.
Operator must be = (exact match) or ^= (starts with).
Secrets (Static Credentials Only)
| Secret | Type | Required | Description |
|---|---|---|---|
access_key | secret | No | The Access Key from AWS to authenticate with AWS |
secret_key | secret | No | The Secret Key from AWS to authenticate with AWS |
⚠️ Authentication: Choose either Role ARN (recommended) or static credentials. See AWS Authentication Guide for setup instructions.
Sample Record
Code
Sync frequency
This input runs on a cron schedule (default hourly, 0 * * * *), which you can configure on the pipeline.
See Input Sync Frequency for details.
Related Articles
Community transforms
The Monad Transforms Repository has ready-made transforms for this input. Import one into your organization, then add it to a pipeline after this input.
| Format | Transform |
|---|---|
| OCSF v1.9.0 | AWS Cognito Users to OCSF v1.9.0 |
| ECS v9.5.0 | AWS Cognito Users to ECS v9.5.0 |
| CEF | AWS Cognito Users to CEF |
CEF transforms emit an intermediate record; add the CEF Serializer transform after one to produce the CEF:0 string.