Event source for Amazon Cognito User Pools

This event source captures messages from an Amazon Cognito User Pool whenever a specific action, such as the creation of a new user, happens in the user identity pool.

Prerequisite(s)

• Amazon Cognito User Pool
• Amazon Resource Name (ARN)
• API Credentials

Amazon Cognito User Pool

If you don't already have an Amazon Cognito User Pool, create one by following the instructions in the Getting started with User Pools guide.

Amazon Resource Name (ARN)

A fully qualified ARN is required to uniquely identify the Amazon Cognito User Pool.

As shown in the above screenshot, you can obtain the ARN of a User Pool from the AWS console. It typically has the following format:

arn:aws:cognito-idp:{awsRegion}:{awsAccountId}:userpool/{poolId}

Alternatively you can also use the [AWS CLI][aws-cli]. The following command retrieves the ARN of a User Pool in the us-west-2 region which has the pool id us-west-2_fak3p001B.

$ aws --region us-west-2 cognito-idp describe-user-pool --user-pool-id us-west-2_fak3p001B
{
    "UserPool": {
        "Id": "us-west-2_fak3p001B",
        ...
        "Arn": "arn:aws:cognito-idp:us-west-2:043455440429:userpool/us-west-2_fak3p001B",
        ...
    }
}

API credentials

The TriggerMesh event source for Amazon Cognito User Pools authenticates calls to the AWS API using AWS Access Keys. The page Understanding and getting your AWS credentials contains instructions to create access keys when signed-in either as the root user or as an IAM user. Take note of the Access Key ID and Secret Access Key, they will be used to create an instance of the event source.

It is considered a good practice to create dedicated users with restricted privileges in order to programmatically access AWS services. Permissions can be added or revoked granularly for a given IAM user by attaching IAM Policies to it.

As an example, the following policy contains the permissions required by the TriggerMesh Amazon Cognito User Pool event source to list users in any user pool associated with the AWS account:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "AWSCognitoUserPoolSourceReceiveAdapter",
            "Effect": "Allow",
            "Action": [
                "cognito-idp:DescribeUserPool",
                "cognito-idp:ListUsers"
            ],
            "Resource": "arn:aws:cognito-idp:*:*:userpool/*"
        }
    ]
}

Deploying an instance of the Source

Open the Bridge creation screen and add a source of type Amazon Cognito User Pool.

In the Source creation form, give a name to the event source and add the following information:

• Secret: Reference to a TriggerMesh secret containing an Access Key ID and a Secret Access Key to communicate with the Amazon Cognito API, as described in the previous sections.
• AWS ARN: ARN of the User Pool, as described in the previous sections.

After clicking the Save button, you will be taken back to the Bridge editor. Proceed to adding the remaining components to the Bridge, then submit it.

A ready status on the main Bridges page indicates that the event source is ready to receive notifications from the Amazon Cognito User Pool.

Event Types

The Amazon Cognito User Pool event source emits events of the following type:

• com.amazon.cognito-idp.sync_trigger