Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setting disable_execute_api_endpoint to false should leavee Execute API endpoint enabled. #134

Open
dgholz opened this issue Feb 19, 2025 · 1 comment

Comments

@dgholz
Copy link

dgholz commented Feb 19, 2025

Description

Recreating #128, since it went stale.

We'd still like this to work, our motivations are unchanged:

For our use case, we'd like to leave the default endpoint available when we have a domain configured.

We have an externally-facing API that clients request jobs through. Their requests get forwarded onto a Step Function to perform the work. To allow the clients to view the progress of their work, the Step Functions send updates to the API with status messages (stored in DynamoDB) that the clients can then retrieve. We use API Gateway: Invoke tasks from the Step Function to access the API Gateway, which require an execute-api endpoint parameter to specify which API Gateway to invoke. We prefer sending our own status messages, so they are understandable to the clients, rather than the description of the Step Function execution (which sometimes are harder to map to user intentions).

We're happy to leave the default endpoint enabled: even though it would allow clients to directly invoke the API Gateway, we don't publish it for them to use & restrict access to the routes with IAM authentication. We prefer clients to use the domain name, in case we replace the API Gateway in the future & its ID changes. If API Gateway: Invoke tasks could use the domain name instead of the execute-api endpoint, we'd happily switch.

I guess we could configure two APIs: one for clients to use & another for our Step Functions to call. Though we would have to configure the Step Functions to look up the appropriate API Gateway to use, instead of passing it through from the API Gateway's context.

@dgholz
Copy link
Author

dgholz commented Feb 19, 2025

I make #130 to resolve this issue, but it also went stale. Happy to re-create it as well, and take on any suggestions to improve the testing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant