User Pool Client

Resource Overview

A User Pool Client resource represents an Amazon Cognito User Pool Client that provides a way to generate authentication tokens used to authorize a user for an application. Configuring a User Pool Client then connecting it to a User Pool will generate to a User Pool client ID. An application will need this client ID in order for it to access the User Pool, in addition to the necessary User Pool's identifiers.

Configurable Properties

Logical ID

The unique identifier used to reference this resource in the stack template. Defining a custom Logical ID is recommended, as it allows you to quickly identify a resource and any associated sub-resources when working with your stack in AWS, or anywhere outside of the Stackery Dashboard. As a project grows, it becomes useful in quickly spotting this resource in template.yaml or while viewing a stack in Template View mode.

The Logical ID of all sub-resources associated with this User Pool Client will be prefixed with this value.

The identifier you provide must only contain alphanumeric characters (A-Za-z0-9) and be unique within the stack.

Default Logical ID Example: UserPoolClient2

IMPORTANT : AWS uses the Logical ID of each resource to coordinate and apply updates to the stack when deployed. On any update of a resource's logical ID (or any modification that results in one), CloudFormation will delete the currently deployed resource and create a new one in its place when the updated stack is deployed.

Environment Variables

When connected by a service discovery wire (dashed wire), a Function, Docker Task or Edge Function will automatically populate and reference the following environment variables in order to interact with this resource.

USER_POOL_CLIENT_ID

The unique identifier for the User Pool Client

Example: 1h57kf5cpq17m0eml12EXAMPLE

Related AWS Documentation

AWS Documentation: AWS::Cognito::UserPool