Skip to content

Commit

Permalink
Expose APIGW stage ARN (#29)
Browse files Browse the repository at this point in the history
  • Loading branch information
paul-ylz authored Jan 12, 2024
1 parent 6573bfc commit 980f4b2
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 3 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ API gateway module for REST API. There is no community module available for REST

| Name | Version |
|------|---------|
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.67.0 |
| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.31.0 |

## Modules

Expand Down Expand Up @@ -74,6 +74,7 @@ API gateway module for REST API. There is no community module available for REST
| <a name="output_aws_api_gateway_execution_arn"></a> [aws\_api\_gateway\_execution\_arn](#output\_aws\_api\_gateway\_execution\_arn) | The execution ARN part to be used in lambda\_permission source\_arn when allowing API Gateway to invoke a Lambda function |
| <a name="output_aws_api_gateway_rest_api_id"></a> [aws\_api\_gateway\_rest\_api\_id](#output\_aws\_api\_gateway\_rest\_api\_id) | REST API id of the created api |
| <a name="output_aws_api_gateway_rest_api_root_resource_id"></a> [aws\_api\_gateway\_rest\_api\_root\_resource\_id](#output\_aws\_api\_gateway\_rest\_api\_root\_resource\_id) | Root resource ID of the API Gateway REST API |
| <a name="output_aws_api_gateway_stage_arn"></a> [aws\_api\_gateway\_stage\_arn](#output\_aws\_api\_gateway\_stage\_arn) | ARN (for management) of apigw stage, use this when attaching Web ACL |
| <a name="output_aws_api_gateway_stage_execution_arn"></a> [aws\_api\_gateway\_stage\_execution\_arn](#output\_aws\_api\_gateway\_stage\_execution\_arn) | The execution ARN part to be used in lambda\_permission source\_arn when allowing API Gateway to invoke a Lambda function |
| <a name="output_aws_api_gateway_stage_invoke_url"></a> [aws\_api\_gateway\_stage\_invoke\_url](#output\_aws\_api\_gateway\_stage\_invoke\_url) | The URL to invoke the API pointing to the stage |
| <a name="output_aws_api_gateway_stage_name"></a> [aws\_api\_gateway\_stage\_name](#output\_aws\_api\_gateway\_stage\_name) | Stage name of the deployed api gateway stage |
Expand Down
2 changes: 1 addition & 1 deletion modules/custom_domain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Provisions option to create ACM certifcation. Cert validation needs to be done o

| Name | Version |
|------|---------|
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.67.0 |
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.63.0 |

## Modules

Expand Down
5 changes: 4 additions & 1 deletion modules/usage_plan/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Create Usage Plan and assign it to the API

| Name | Version |
|------|---------|
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.67.0 |
| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.63.0 |

## Modules

Expand All @@ -33,12 +33,15 @@ No modules.
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_api_keys"></a> [api\_keys](#input\_api\_keys) | List of api keys created and assigned to the usage plan | <pre>map(<br> object({<br> key_name = string<br> enabled = bool<br> })<br> )</pre> | `{}` | no |
| <a name="input_burst_limit"></a> [burst\_limit](#input\_burst\_limit) | The maximum number of requests that API Gateway allows to be bursted across the entire API at the same moment. | `number` | `5000` | no |
| <a name="input_default_tags"></a> [default\_tags](#input\_default\_tags) | Default Tags for Auto Scaling Group | `map(string)` | `{}` | no |
| <a name="input_enable_throttling"></a> [enable\_throttling](#input\_enable\_throttling) | whether to enable throttling | `bool` | `false` | no |
| <a name="input_limit"></a> [limit](#input\_limit) | The maximum number of requests that can be made in a given time period. | `number` | `5000` | no |
| <a name="input_name"></a> [name](#input\_name) | Usage plan name | `string` | n/a | yes |
| <a name="input_offset"></a> [offset](#input\_offset) | The number of requests subtracted from the given limit in the initial time period. | `number` | `2` | no |
| <a name="input_period"></a> [period](#input\_period) | The time period in which the limit applies. Valid values are DAY, WEEK or MONTH. | `string` | `"MONTH"` | no |
| <a name="input_quota_settings_unlimited"></a> [quota\_settings\_unlimited](#input\_quota\_settings\_unlimited) | Specifies whether there is a unlimited quota limit . | `bool` | `false` | no |
| <a name="input_rate_limit"></a> [rate\_limit](#input\_rate\_limit) | The rate limit, as a number of requests per second, to apply to this usage plan. | `number` | `100` | no |
| <a name="input_stages"></a> [stages](#input\_stages) | List of stages the usage plan can be used | <pre>map(<br> object({<br> api_id = string<br> stage = string<br> })<br> )</pre> | n/a | yes |

## Outputs
Expand Down
5 changes: 5 additions & 0 deletions outputs.tf
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,8 @@ output "aws_api_gateway_rest_api_root_resource_id" {
value = aws_api_gateway_rest_api.api.root_resource_id
description = "Root resource ID of the API Gateway REST API"
}

output "aws_api_gateway_stage_arn" {
value = aws_api_gateway_stage.stage.arn
description = "ARN (for management) of apigw stage, use this when attaching Web ACL"
}

0 comments on commit 980f4b2

Please sign in to comment.