Skip to content

Commit

Permalink
Add troubleshooting for API Gateway creation
Browse files Browse the repository at this point in the history
  • Loading branch information
chuckwondo committed Oct 19, 2023
1 parent 132f715 commit 11ced88
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/TROUBLESHOOTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Troubleshooting

- [Deployment](#deployment)
- [Error creating API Gateway Deployment: BadRequestException: Private REST API doesn't have a resource policy attached to it](#error-creating-api-gateway-deployment-badrequestexception-private-rest-api-doesnt-have-a-resource-policy-attached-to-it)
- [Aws::STS::Errors::InvalidClientTokenId: The security token included in the request is invalid](#awsstserrorsinvalidclienttokenid-the-security-token-included-in-the-request-is-invalid)
- [Error describing SSM parameter: ParameterNotFound](#error-describing-ssm-parameter-parameternotfound)
- [Running "up" Command Stopped](#running-up-command-stopped)
Expand All @@ -18,6 +19,25 @@

## Deployment

### Error creating API Gateway Deployment: BadRequestException: Private REST API doesn't have a resource policy attached to it

You might encounter an error similar to the following during deployment:

```plain
Error: Error creating API Gateway Deployment: BadRequestException: Private REST API doesn't have a resource policy attached to it
on .terraform/modules/orca/modules/api-gateway/main.tf line 498, in resource "aws_api_gateway_deployment" "orca_api_deployment":
498: resource "aws_api_gateway_deployment" "orca_api_deployment" {
```

This is likely due to a race condition between resources, as Terraform often
creates several resources in parallel.

The fix for this problem is simple: **Rerun your deployment command**, and by
the time Terraform again attempts to perform the previously failing operation,
it will succeed. If it fails again, rerun the deployment again, until you no
longer see the error.

### Aws::STS::Errors::InvalidClientTokenId: The security token included in the request is invalid

If you see output similar to the following when running an "up" or "plan"
Expand Down

0 comments on commit 11ced88

Please sign in to comment.