54 lines
3.3 KiB
Markdown
54 lines
3.3 KiB
Markdown
<!-- BEGIN_TF_DOCS -->
|
|
## Requirements
|
|
|
|
| Name | Version |
|
|
|------|---------|
|
|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3.1 |
|
|
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.10.0 |
|
|
|
|
## Providers
|
|
|
|
| Name | Version |
|
|
|------|---------|
|
|
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.38.0 |
|
|
|
|
## Modules
|
|
|
|
No modules.
|
|
|
|
## Resources
|
|
|
|
| Name | Type |
|
|
|------|------|
|
|
| [aws_api_gateway_deployment.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_deployment) | resource |
|
|
| [aws_api_gateway_integration.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_integration) | resource |
|
|
| [aws_api_gateway_integration_response.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_integration_response) | resource |
|
|
| [aws_api_gateway_method.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_method) | resource |
|
|
| [aws_api_gateway_method_response.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_method_response) | resource |
|
|
| [aws_api_gateway_resource.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_resource) | resource |
|
|
| [aws_api_gateway_rest_api.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_rest_api) | resource |
|
|
| [aws_api_gateway_stage.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_stage) | resource |
|
|
| [aws_lambda_permission.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_permission) | resource |
|
|
|
|
## Inputs
|
|
|
|
| Name | Description | Type | Default | Required |
|
|
|------|-------------|------|---------|:--------:|
|
|
| <a name="input_integration"></a> [integration](#input\_integration) | Map of API gateway integrations. | `map(any)` | n/a | yes |
|
|
| <a name="input_integration_response"></a> [integration\_response](#input\_integration\_response) | Map of API gateway method integrations. | `map(any)` | n/a | yes |
|
|
| <a name="input_lambda"></a> [lambda](#input\_lambda) | List of lambdas the API will execute. | `list(any)` | n/a | yes |
|
|
| <a name="input_method"></a> [method](#input\_method) | Map of API gateway methods. | `map(any)` | n/a | yes |
|
|
| <a name="input_method_response"></a> [method\_response](#input\_method\_response) | Map of API gateway method response. | `map(any)` | n/a | yes |
|
|
| <a name="input_name"></a> [name](#input\_name) | The name of the API. | `string` | n/a | yes |
|
|
| <a name="input_role_arn"></a> [role\_arn](#input\_role\_arn) | ARN of the IAM role (credentials). | `string` | n/a | yes |
|
|
| <a name="input_sqs_arn"></a> [sqs\_arn](#input\_sqs\_arn) | ARN of the SQS. | `string` | n/a | yes |
|
|
| <a name="input_tags"></a> [tags](#input\_tags) | A mapping of tags to assign to API gateway resources. | `map(string)` | `{}` | no |
|
|
|
|
## Outputs
|
|
|
|
| Name | Description |
|
|
|------|-------------|
|
|
| <a name="output_endpoint"></a> [endpoint](#output\_endpoint) | n/a |
|
|
| <a name="output_resource_path"></a> [resource\_path](#output\_resource\_path) | n/a |
|
|
| <a name="output_rest_id"></a> [rest\_id](#output\_rest\_id) | n/a |
|
|
<!-- END_TF_DOCS --> |