65 lines
3.9 KiB
Markdown
65 lines
3.9 KiB
Markdown
|
<!-- This readme file is generated with terraform-docs -->
|
||
|
|
## Requirements
|
||
|
|
|
||
|
|
| Name | Version |
|
||
|
|
|------|---------|
|
||
|
|
| terraform | >= 1.3.0 |
|
||
|
|
| aws | >= 5.0 |
|
||
|
|
|
||
|
|
## Providers
|
||
|
|
|
||
|
|
| Name | Version |
|
||
|
|
|------|---------|
|
||
|
|
| aws | >= 5.0 |
|
||
|
|
| random | n/a |
|
||
|
|
|
||
|
|
## Modules
|
||
|
|
|
||
|
|
No modules.
|
||
|
|
|
||
|
|
## Resources
|
||
|
|
|
||
|
|
| Name | Type |
|
||
|
|
|------|------|
|
||
|
|
| [aws_api_gateway_deployment.apigw-deployment](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_deployment) | resource |
|
||
|
|
| [aws_api_gateway_integration.api-integration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_integration) | resource |
|
||
|
|
| [aws_api_gateway_method.api-method](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_method) | resource |
|
||
|
|
| [aws_api_gateway_method_settings.apigw-method-settings](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_method_settings) | resource |
|
||
|
|
| [aws_api_gateway_resource.api-res](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_resource) | resource |
|
||
|
|
| [aws_api_gateway_rest_api.api](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_rest_api) | resource |
|
||
|
|
| [aws_api_gateway_rest_api_policy.api-policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_rest_api_policy) | resource |
|
||
|
|
| [aws_api_gateway_stage.apigw-stage](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_stage) | resource |
|
||
|
|
| [aws_api_gateway_vpc_link.api-vpc-link](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_vpc_link) | resource |
|
||
|
|
| [aws_iam_role.lambda-exec-role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
|
||
|
|
| [aws_iam_role_policy.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | resource |
|
||
|
|
| [aws_lambda_function.function](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_function) | resource |
|
||
|
|
| [aws_lambda_permission.allow_api_gateway](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_permission) | resource |
|
||
|
|
| [aws_vpc_endpoint.apigw-vpcep](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/vpc_endpoint) | resource |
|
||
|
|
| [random_id.this](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/id) | resource |
|
||
|
|
| [aws_caller_identity.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |
|
||
|
|
| [aws_iam_policy_document.api-policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
|
||
|
|
| [aws_region.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | data source |
|
||
|
|
|
||
|
|
## Inputs
|
||
|
|
|
||
|
|
| Name | Description | Type | Default | Required |
|
||
|
|
|------|-------------|------|---------|:--------:|
|
||
|
|
| apigw-security-group-id | Security group id of apigateway | `string` | n/a | yes |
|
||
|
|
| apigw-subnet-ids | Subnet IDs of apigateway | `list(string)` | n/a | yes |
|
||
|
|
| apigw-vpc-id | VPC id of apigateway | `string` | n/a | yes |
|
||
|
|
| apigw-vpc-link-target-arns | Target arns for apigateway VPC link | `list(string)` | `[]` | no |
|
||
|
|
| create-vpc-link | Set true to create vpc link for outbound access to specific targets | `bool` | n/a | yes |
|
||
|
|
| description | Description of apigateway | `string` | n/a | yes |
|
||
|
|
| lambda-archive-file | Path to lambda zip archive | `string` | n/a | yes |
|
||
|
|
| lambda-runtime-version | Lambda runtime version | `string` | `"python3.12"` | no |
|
||
|
|
| name | Name of apigateway | `string` | n/a | yes |
|
||
|
|
| path\_part | Last path segment of this API resource | `string` | n/a | yes |
|
||
|
|
| stage-name | Apigateway stage name | `string` | n/a | yes |
|
||
|
|
|
||
|
|
## Outputs
|
||
|
|
|
||
|
|
No outputs.
|
||
|
|
|
||
|
|
---
|
||
|
|
## Authorship
|
||
|
|
This module was developed by Rackspace.
|