Skip to main content

Cognito location

Overview

A Cognito location supports a relatively limited subset of queries (specifically filtering by username).

However, writes to the location create/update/delete authenticated users immediately.

Fields defined on the user model in Cognito are mapped to schema properties using the following rules:

  • for standard fields, a lowerCamel name in the schema maps to a lower_underscore name in Cognito
    • e.g. givenName in the schema -> given_name in Cognito
  • for custom fields, the same applies except custom: is included in the Cognito name:
    • e.g. myCustomField in the schema -> custom:my_custom_field in Cognito

The following configuration properties are supported:

  • userPoolId Id of the user pool
  • region Region of the user pool
  • clientId Id of a client that is configured to authenticate against the provided user pool
  • roleArn Optional role arn with permission to administer users, if provided then CRUD operations will be supported, otherwise this pool is used only for authentication