func-api-users-get

Overview

Deploys the Lambda function that handles GET /users. Returns a list of all users from the DynamoDB allowlist table. The route is authenticated via the Cognito JWT authorizer.

CloudFormation Stack

firefly-func-api-users-get

CloudWatch Logs

Setting	Value
Log group	/aws/lambda/firefly-func-api-users-get
Retention	30 days

Dependencies

Deploy Dependencies

Workflow	Reason
api-gateway	ApiId and AuthorizerId resolved from stack outputs
cognito	Authorizer is created as part of the api-gateway stack, which depends on Cognito

Delete Dependencies

None — this workflow has no prerequisites.

Required By

Required By Deploy

Workflow	Reason
run-integration-tests	Endpoint must be live before integration tests run

Required By Delete

Workflow	Reason
delete-api-gateway	Route registration must be removed before the API Gateway stack is deleted

Deploy Workflow

Description

Resolves the HTTP API Gateway ID and JWT Authorizer ID from the firefly-api-gateway stack outputs, then performs a SAM build and deploy. The function is granted read access to the DynamoDB users table.

Steps

1. Configure AWS credentials.
2. Look up ApiId from the firefly-api-gateway stack output.
3. Look up AuthorizerId from the firefly-api-gateway stack output.
4. SAM build.
5. SAM deploy firefly-func-api-users-get with parameters:
   • ApiId
   • AuthorizerId
   • DynamoDbUsersTableName (from secrets)

Sequence Diagram

Delete Workflow

Description

Calls sam delete to remove the Lambda function and its associated IAM role and API Gateway route integration.

Steps

1. Configure AWS credentials.
2. SAM delete firefly-func-api-users-get.

Sequence Diagram

Failure Scenarios

Scenario	Behavior
firefly-api-gateway stack not found	describe-stacks returns an error; workflow fails before SAM deploy is attempted. Deploy api-gateway first.
Authorizer ID lookup fails	Deploy fails; the JWT authorizer is created by the api-gateway stack — redeploy api-gateway to restore it.
DynamoDB users table not deployed	Function deploys successfully but returns errors at runtime when querying the table. Deploy dynamodb-users and ensure DynamoDbUsersTableName is correct.