Skip to content

Commit

Permalink
Updated with the [latest changes](gruntwork-io/terraform-aws-lambda#241
Browse files Browse the repository at this point in the history
…) from the `terraform-aws-lambda@fix-unit-test` source branch.
  • Loading branch information
docs-sourcer[bot] committed Jun 22, 2024
1 parent ffa383f commit 6c72f00
Show file tree
Hide file tree
Showing 12 changed files with 146 additions and 207 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";

<VersionBadge repoTitle="AWS Lambda" version="0.21.19" lastModifiedVersion="0.21.15"/>
<VersionBadge repoTitle="AWS Lambda" version="0.22.0" lastModifiedVersion="0.21.15"/>

# API Gateway Account Settings Module

<a href="https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/api-gateway-account-settings" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
<a href="https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/api-gateway-account-settings" className="link-button" title="View the source code for this module in GitHub.">View Source</a>

<a href="https://github.com/gruntwork-io/terraform-aws-lambda/releases/tag/v0.21.15" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>

Expand All @@ -34,7 +34,7 @@ The corresponding screen from the AWS Console is shown below:

## Quick start

Check out the [examples](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/examples) for sample code that demonstrates how to use this module.
Check out the [examples](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/examples) for sample code that demonstrates how to use this module.

## Sample Usage

Expand All @@ -49,7 +49,7 @@ Check out the [examples](https://github.com/gruntwork-io/terraform-aws-lambda/tr
module "api_gateway_account_settings" {
source = "git::git@github.com:gruntwork-io/terraform-aws-lambda.git//modules/api-gateway-account-settings?ref=v0.21.19"
source = "git::git@github.com:gruntwork-io/terraform-aws-lambda.git//modules/api-gateway-account-settings?ref=v0.22.0"
# ----------------------------------------------------------------------------------------------------
# OPTIONAL VARIABLES
Expand Down Expand Up @@ -91,7 +91,7 @@ module "api_gateway_account_settings" {
# ------------------------------------------------------------------------------------------------------
terraform {
source = "git::git@github.com:gruntwork-io/terraform-aws-lambda.git//modules/api-gateway-account-settings?ref=v0.21.19"
source = "git::git@github.com:gruntwork-io/terraform-aws-lambda.git//modules/api-gateway-account-settings?ref=v0.22.0"
}
inputs = {
Expand Down Expand Up @@ -191,11 +191,11 @@ When true, all IAM policies will be managed as dedicated policies rather than in
<!-- ##DOCS-SOURCER-START
{
"originalSources": [
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/api-gateway-account-settings/readme.md",
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/api-gateway-account-settings/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/api-gateway-account-settings/outputs.tf"
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/api-gateway-account-settings/readme.md",
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/api-gateway-account-settings/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/api-gateway-account-settings/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "287c7c551bd10e949997a0b18d08bf28"
"hash": "4758b1015b38beeb3dab6c1be94f24b7"
}
##DOCS-SOURCER-END -->
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,20 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";

<VersionBadge repoTitle="AWS Lambda" version="0.21.19" lastModifiedVersion="0.20.0"/>
<VersionBadge repoTitle="AWS Lambda" version="0.22.0" lastModifiedVersion="0.22.0"/>

# API Gateway Lambda Function Proxy Methods Module

<a href="https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/api-gateway-proxy-methods" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
<a href="https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/api-gateway-proxy-methods" className="link-button" title="View the source code for this module in GitHub.">View Source</a>

<a href="https://github.com/gruntwork-io/terraform-aws-lambda/releases/tag/v0.20.0" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
<a href="https://github.com/gruntwork-io/terraform-aws-lambda/releases/tag/v0.22.0" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>

This module must be used in conjunction with [the api-gateway-proxy module](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/api-gateway-proxy) to configure an API
This module must be used in conjunction with [the api-gateway-proxy module](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/api-gateway-proxy) to configure an API
Gateway REST API to route all requests from a root path to a lambda function.

Refer to [the module docs](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/api-gateway-proxy/README.md) for the `api-gateway-proxy` module for more details on how to
Refer to [the module docs](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/api-gateway-proxy/README.md) for the `api-gateway-proxy` module for more details on how to
use this module. Specifically, see the section [Can I expose additional lambda functions in a decentralized
manner?](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/api-gateway-proxy/core-concepts.md#can-i-expose-additional-lambda-functions-in-a-decentralized-manner)
manner?](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/api-gateway-proxy/core-concepts.md#can-i-expose-additional-lambda-functions-in-a-decentralized-manner)

## Sample Usage

Expand All @@ -37,7 +37,7 @@ manner?](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modu
module "api_gateway_proxy_methods" {
source = "git::git@github.com:gruntwork-io/terraform-aws-lambda.git//modules/api-gateway-proxy-methods?ref=v0.21.19"
source = "git::git@github.com:gruntwork-io/terraform-aws-lambda.git//modules/api-gateway-proxy-methods?ref=v0.22.0"
# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
Expand Down Expand Up @@ -85,7 +85,7 @@ module "api_gateway_proxy_methods" {
# ------------------------------------------------------------------------------------------------------
terraform {
source = "git::git@github.com:gruntwork-io/terraform-aws-lambda.git//modules/api-gateway-proxy-methods?ref=v0.21.19"
source = "git::git@github.com:gruntwork-io/terraform-aws-lambda.git//modules/api-gateway-proxy-methods?ref=v0.22.0"
}
inputs = {
Expand Down Expand Up @@ -293,11 +293,11 @@ ID of the API Gateway method for the root proxy (only created if path_prefix is
<!-- ##DOCS-SOURCER-START
{
"originalSources": [
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/api-gateway-proxy-methods/readme.md",
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/api-gateway-proxy-methods/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/api-gateway-proxy-methods/outputs.tf"
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/api-gateway-proxy-methods/readme.md",
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/api-gateway-proxy-methods/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/api-gateway-proxy-methods/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "1fcb89b8f3745bbeedf1d98e752807d8"
"hash": "348b6e27cb176eb485589684bf429114"
}
##DOCS-SOURCER-END -->
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";

<VersionBadge repoTitle="AWS Lambda" version="0.21.19" lastModifiedVersion="0.21.18"/>
<VersionBadge repoTitle="AWS Lambda" version="0.22.0" lastModifiedVersion="0.22.0"/>

# API Gateway Proxy Module

<a href="https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/api-gateway-proxy" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
<a href="https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/api-gateway-proxy" className="link-button" title="View the source code for this module in GitHub.">View Source</a>

<a href="https://github.com/gruntwork-io/terraform-aws-lambda/releases/tag/v0.21.18" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
<a href="https://github.com/gruntwork-io/terraform-aws-lambda/releases/tag/v0.22.0" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>

This module creates an [API Gateway](https://aws.amazon.com/api-gateway/) that can be used to expose your serverless
applications running in [AWS Lambda](https://aws.amazon.com/lambda/).
Expand All @@ -34,7 +34,7 @@ recommend using a framework like Serverless to avoid the verbose configuration o
:::note

If you are looking for a module to route different requests and methods to different Lambda functions, refer to the
[lambda-http-api-gateway](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/lambda-http-api-gateway) module.
[lambda-http-api-gateway](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/lambda-http-api-gateway) module.

:::

Expand All @@ -58,33 +58,33 @@ before, make sure to read [How to use the Gruntwork Infrastructure as Code Libra

### Core concepts

* [What is API Gateway?](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/api-gateway-proxy/core-concepts.md#what-is-api-gateway)
* [What is API Gateway?](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/api-gateway-proxy/core-concepts.md#what-is-api-gateway)
* [What is the difference between the different endpoint
types?](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/api-gateway-proxy/core-concepts.md#what-is-the-difference-between-the-different-endpoint-types)
types?](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/api-gateway-proxy/core-concepts.md#what-is-the-difference-between-the-different-endpoint-types)
* [API Gateway Documentation](https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html): Amazon's docs
on API Gateway covering core concepts such as security, monitoring, and invoking APIs.

### Repo organization

* [modules](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules): the main implementation code for this repo, broken down into multiple standalone, orthogonal submodules.
* [examples](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/examples): This folder contains working examples of how to use the submodules.
* [test](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/test): Automated tests for the modules and examples.
* [modules](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules): the main implementation code for this repo, broken down into multiple standalone, orthogonal submodules.
* [examples](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/examples): This folder contains working examples of how to use the submodules.
* [test](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/test): Automated tests for the modules and examples.

## Deploy

If you just want to try this repo out for experimenting and learning, check out the following resources:

* [examples folder](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/examples): The `examples` folder contains sample code optimized for learning, experimenting, and testing (but not production usage).
* [examples folder](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/examples): The `examples` folder contains sample code optimized for learning, experimenting, and testing (but not production usage).

## Manage

### Day-to-day operations

* [How do I expose AWS Lambda functions using API
Gateway?](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/api-gateway-proxy/core-concepts.md#how-do-i-expose-aws-lambda-functions-using-api-gateway)
Gateway?](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/api-gateway-proxy/core-concepts.md#how-do-i-expose-aws-lambda-functions-using-api-gateway)
* [Can I expose additional lambda functions in a decentralized
manner?](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/api-gateway-proxy/core-concepts.md#can-i-expose-additional-lambda-functions-in-a-decentralized-manner)
* [How do I pass in the us_east\_1 aws provider?](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/api-gateway-proxy/core-concepts.md#how-do-i-pass-in-the-us_east\_1-aws-provider)
manner?](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/api-gateway-proxy/core-concepts.md#can-i-expose-additional-lambda-functions-in-a-decentralized-manner)
* [How do I pass in the us_east\_1 aws provider?](https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/api-gateway-proxy/core-concepts.md#how-do-i-pass-in-the-us_east\_1-aws-provider)

## Sample Usage

Expand All @@ -99,7 +99,7 @@ If you just want to try this repo out for experimenting and learning, check out
module "api_gateway_proxy" {
source = "git::git@github.com:gruntwork-io/terraform-aws-lambda.git//modules/api-gateway-proxy?ref=v0.21.19"
source = "git::git@github.com:gruntwork-io/terraform-aws-lambda.git//modules/api-gateway-proxy?ref=v0.22.0"
# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
Expand Down Expand Up @@ -242,6 +242,9 @@ module "api_gateway_proxy" {
# Name of the stage to create with this API Gateway deployment.
stage_name = "live"
# Whether active tracing with X-ray is enabled.
stage_xray_tracing_enabled = true
}
Expand All @@ -257,7 +260,7 @@ module "api_gateway_proxy" {
# ------------------------------------------------------------------------------------------------------
terraform {
source = "git::git@github.com:gruntwork-io/terraform-aws-lambda.git//modules/api-gateway-proxy?ref=v0.21.19"
source = "git::git@github.com:gruntwork-io/terraform-aws-lambda.git//modules/api-gateway-proxy?ref=v0.22.0"
}
inputs = {
Expand Down Expand Up @@ -403,6 +406,9 @@ inputs = {
# Name of the stage to create with this API Gateway deployment.
stage_name = "live"
# Whether active tracing with X-ray is enabled.
stage_xray_tracing_enabled = true
}
Expand Down Expand Up @@ -715,6 +721,15 @@ Name of the stage to create with this API Gateway deployment.
<HclListItemDefaultValue defaultValue="&quot;live&quot;"/>
</HclListItem>

<HclListItem name="stage_xray_tracing_enabled" requirement="optional" type="bool">
<HclListItemDescription>

Whether active tracing with X-ray is enabled.

</HclListItemDescription>
<HclListItemDefaultValue defaultValue="true"/>
</HclListItem>

</TabItem>
<TabItem value="outputs" label="Outputs">

Expand Down Expand Up @@ -757,11 +772,11 @@ The URL of the API Gateway that you can use to invoke it.
<!-- ##DOCS-SOURCER-START
{
"originalSources": [
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/api-gateway-proxy/readme.md",
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/api-gateway-proxy/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/api-gateway-proxy/outputs.tf"
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/api-gateway-proxy/readme.md",
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/api-gateway-proxy/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/api-gateway-proxy/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "6092e97455f033e64255433a3e9ca454"
"hash": "b3076a0174971d9fca875687770a025e"
}
##DOCS-SOURCER-END -->
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";

<VersionBadge repoTitle="AWS Lambda" version="0.21.19" lastModifiedVersion="0.21.16"/>
<VersionBadge repoTitle="AWS Lambda" version="0.22.0" lastModifiedVersion="0.21.16"/>

# Keep Warm Module

<a href="https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/keep-warm" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
<a href="https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/keep-warm" className="link-button" title="View the source code for this module in GitHub.">View Source</a>

<a href="https://github.com/gruntwork-io/terraform-aws-lambda/releases/tag/v0.21.16" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>

Expand Down Expand Up @@ -60,7 +60,7 @@ level](#concurrency) for your functions.
module "keep_warm" {
source = "git::git@github.com:gruntwork-io/terraform-aws-lambda.git//modules/keep-warm?ref=v0.21.19"
source = "git::git@github.com:gruntwork-io/terraform-aws-lambda.git//modules/keep-warm?ref=v0.22.0"
# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
Expand Down Expand Up @@ -133,7 +133,7 @@ module "keep_warm" {
# ------------------------------------------------------------------------------------------------------
terraform {
source = "git::git@github.com:gruntwork-io/terraform-aws-lambda.git//modules/keep-warm?ref=v0.21.19"
source = "git::git@github.com:gruntwork-io/terraform-aws-lambda.git//modules/keep-warm?ref=v0.22.0"
}
inputs = {
Expand Down Expand Up @@ -340,11 +340,11 @@ When true, all IAM policies will be managed as dedicated policies rather than in
<!-- ##DOCS-SOURCER-START
{
"originalSources": [
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/keep-warm/readme.md",
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/keep-warm/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.21.19/modules/keep-warm/outputs.tf"
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/keep-warm/readme.md",
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/keep-warm/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-lambda/tree/v0.22.0/modules/keep-warm/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "2e91398a7fbb49e5f592a8b3024faa09"
"hash": "1374108f49827690f54fd83d68a7a0c4"
}
##DOCS-SOURCER-END -->
Loading

0 comments on commit 6c72f00

Please sign in to comment.