|
1 | 1 | <!-- BEGIN_TF_DOCS --> |
| 2 | + |
2 | 3 | ## Requirements |
3 | 4 |
|
4 | | -| Name | Version | |
5 | | -|------|---------| |
6 | | -| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | 1.13.4 | |
| 5 | +| Name | Version | |
| 6 | +| ------------------------------------------------------------------------ | ------- | |
| 7 | +| <a name="requirement_terraform"></a> [terraform](#requirement_terraform) | 1.13.4 | |
7 | 8 |
|
8 | 9 | ## Providers |
9 | 10 |
|
10 | | -| Name | Version | |
11 | | -|------|---------| |
12 | | -| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a | |
| 11 | +| Name | Version | |
| 12 | +| ------------------------------------------------ | ------- | |
| 13 | +| <a name="provider_aws"></a> [aws](#provider_aws) | n/a | |
13 | 14 |
|
14 | 15 | ## Modules |
15 | 16 |
|
16 | 17 | No modules. |
17 | 18 |
|
18 | 19 | ## Resources |
19 | 20 |
|
20 | | -| Name | Type | |
21 | | -|------|------| |
22 | | -| [aws_api_gateway_base_path_mapping.dns_mapping](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_base_path_mapping) | resource | |
23 | | -| [aws_api_gateway_deployment.ingress](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_deployment) | resource | |
24 | | -| [aws_api_gateway_domain_name.proxy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_domain_name) | resource | |
25 | | -| [aws_api_gateway_integration.lambda](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_integration) | resource | |
26 | | -| [aws_api_gateway_method.lambda_method](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_method) | resource | |
27 | | -| [aws_api_gateway_method_settings.log_settings](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_method_settings) | resource | |
28 | | -| [aws_api_gateway_resource.lambda_endpoint](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_resource) | resource | |
29 | | -| [aws_api_gateway_resource.webhook](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_resource) | resource | |
30 | | -| [aws_api_gateway_rest_api.ingress_api](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_rest_api) | resource | |
31 | | -| [aws_api_gateway_rest_api_policy.allow_list](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_rest_api_policy) | resource | |
32 | | -| [aws_api_gateway_stage.ingress](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_stage) | resource | |
33 | | -| [aws_cloudwatch_dashboard.metrics](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_dashboard) | resource | |
34 | | -| [aws_cloudwatch_log_group.apigw](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | resource | |
35 | | -| [aws_cloudwatch_log_group.lambda](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | resource | |
36 | | -| [aws_iam_role.proxy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource | |
37 | | -| [aws_iam_role_policy.apigw_logging](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | resource | |
38 | | -| [aws_iam_role_policy.extra_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | resource | |
39 | | -| [aws_iam_role_policy.lambda](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | resource | |
40 | | -| [aws_iam_role_policy_attachment.basic_execution](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource | |
41 | | -| [aws_iam_role_policy_attachment.vpc_execution](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource | |
42 | | -| [aws_lambda_function.proxy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_function) | resource | |
43 | | -| [aws_lambda_permission.apigw_lambda](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_permission) | resource | |
44 | | -| [aws_route53_record.proxy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource | |
45 | | -| [aws_security_group.lambda](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource | |
46 | | -| [aws_iam_policy_document.allow_list](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | |
47 | | -| [aws_iam_policy_document.apigw_logging](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | |
48 | | -| [aws_iam_policy_document.lambda_logging](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | |
49 | | -| [aws_iam_policy_document.proxy_service](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | |
50 | | -| [aws_s3_object.proxy_lambda](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/s3_object) | data source | |
| 21 | +| Name | Type | |
| 22 | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | |
| 23 | +| [aws_api_gateway_base_path_mapping.dns_mapping](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_base_path_mapping) | resource | |
| 24 | +| [aws_api_gateway_deployment.ingress](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_deployment) | resource | |
| 25 | +| [aws_api_gateway_domain_name.proxy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_domain_name) | resource | |
| 26 | +| [aws_api_gateway_integration.lambda](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_integration) | resource | |
| 27 | +| [aws_api_gateway_method.lambda_method](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_method) | resource | |
| 28 | +| [aws_api_gateway_method_settings.log_settings](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_method_settings) | resource | |
| 29 | +| [aws_api_gateway_resource.lambda_endpoint](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_resource) | resource | |
| 30 | +| [aws_api_gateway_resource.webhook](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_resource) | resource | |
| 31 | +| [aws_api_gateway_rest_api.ingress_api](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_rest_api) | resource | |
| 32 | +| [aws_api_gateway_rest_api_policy.allow_list](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_rest_api_policy) | resource | |
| 33 | +| [aws_api_gateway_stage.ingress](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_stage) | resource | |
| 34 | +| [aws_cloudwatch_dashboard.metrics](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_dashboard) | resource | |
| 35 | +| [aws_cloudwatch_log_group.apigw](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | resource | |
| 36 | +| [aws_cloudwatch_log_group.lambda](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | resource | |
| 37 | +| [aws_iam_role.proxy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource | |
| 38 | +| [aws_iam_role_policy.apigw_logging](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | resource | |
| 39 | +| [aws_iam_role_policy.extra_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | resource | |
| 40 | +| [aws_iam_role_policy.lambda](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | resource | |
| 41 | +| [aws_iam_role_policy_attachment.basic_execution](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource | |
| 42 | +| [aws_iam_role_policy_attachment.vpc_execution](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource | |
| 43 | +| [aws_lambda_function.proxy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_function) | resource | |
| 44 | +| [aws_lambda_permission.apigw_lambda](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_permission) | resource | |
| 45 | +| [aws_route53_record.proxy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource | |
| 46 | +| [aws_security_group.lambda](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource | |
| 47 | +| [aws_iam_policy_document.allow_list](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | |
| 48 | +| [aws_iam_policy_document.apigw_logging](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | |
| 49 | +| [aws_iam_policy_document.lambda_logging](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | |
| 50 | +| [aws_iam_policy_document.proxy_service](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | |
| 51 | +| [aws_s3_object.proxy_lambda](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/s3_object) | data source | |
51 | 52 |
|
52 | 53 | ## Inputs |
53 | 54 |
|
54 | | -| Name | Description | Type | Default | Required | |
55 | | -|------|-------------|------|---------|:--------:| |
56 | | -| <a name="input_api_gateway_domain_name"></a> [api\_gateway\_domain\_name](#input\_api\_gateway\_domain\_name) | Domain name for API gateway domain mapping | `string` | `null` | no | |
57 | | -| <a name="input_aws_region"></a> [aws\_region](#input\_aws\_region) | The AWS region to deploy to (e.g. us-east-1) | `string` | n/a | yes | |
58 | | -| <a name="input_certificate_arn"></a> [certificate\_arn](#input\_certificate\_arn) | Certificate ARN for API gateway domain name | `string` | `null` | no | |
59 | | -| <a name="input_custom_tags"></a> [custom\_tags](#input\_custom\_tags) | Additional tags to be applied to all resources applied by this module. | `map(string)` | `{}` | no | |
60 | | -| <a name="input_enterprise_managed_user_suffix"></a> [enterprise\_managed\_user\_suffix](#input\_enterprise\_managed\_user\_suffix) | Managed user suffix used for central identity management on GHEC | `string` | `""` | no | |
61 | | -| <a name="input_enterprise_slug"></a> [enterprise\_slug](#input\_enterprise\_slug) | The name (slug) of the enterprise on GHEC | `string` | n/a | yes | |
62 | | -| <a name="input_extra_role_policy"></a> [extra\_role\_policy](#input\_extra\_role\_policy) | jsonencoded string policy to include in the proxy lambda role | `string` | `null` | no | |
63 | | -| <a name="input_lambda_bucket_name"></a> [lambda\_bucket\_name](#input\_lambda\_bucket\_name) | S3 bucket with lambda and layer archives | `string` | n/a | yes | |
64 | | -| <a name="input_lambda_layer_arn"></a> [lambda\_layer\_arn](#input\_lambda\_layer\_arn) | Lambda layer ARN for data store | `string` | n/a | yes | |
65 | | -| <a name="input_lambda_timeout_seconds"></a> [lambda\_timeout\_seconds](#input\_lambda\_timeout\_seconds) | Number of seconds until lambda times out | `number` | `10` | no | |
66 | | -| <a name="input_log_retention_days"></a> [log\_retention\_days](#input\_log\_retention\_days) | Number of days CloudWatch will retain logs | `number` | `7` | no | |
67 | | -| <a name="input_resource_prefix"></a> [resource\_prefix](#input\_resource\_prefix) | Prefix of webhook proxy resources | `string` | `"gwp"` | no | |
68 | | -| <a name="input_route_53_record_name"></a> [route\_53\_record\_name](#input\_route\_53\_record\_name) | Record name for Route 53 record creation | `string` | `null` | no | |
69 | | -| <a name="input_subnet_ids"></a> [subnet\_ids](#input\_subnet\_ids) | subnet\_ids for Lambda VPC config | `list(string)` | n/a | yes | |
70 | | -| <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | VPC id for Lambda VPC config | `string` | n/a | yes | |
71 | | -| <a name="input_zone_id"></a> [zone\_id](#input\_zone\_id) | Zone id for Route53 record | `string` | `null` | no | |
| 55 | +| Name | Description | Type | Default | Required | |
| 56 | +| --------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -------------- | ------- | :------: | |
| 57 | +| <a name="input_api_gateway_domain_name"></a> [api_gateway_domain_name](#input_api_gateway_domain_name) | Domain name for API gateway domain mapping | `string` | `null` | no | |
| 58 | +| <a name="input_aws_region"></a> [aws_region](#input_aws_region) | The AWS region to deploy to (e.g. us-east-1) | `string` | n/a | yes | |
| 59 | +| <a name="input_certificate_arn"></a> [certificate_arn](#input_certificate_arn) | Certificate ARN for API gateway domain name | `string` | `null` | no | |
| 60 | +| <a name="input_custom_tags"></a> [custom_tags](#input_custom_tags) | Additional tags to be applied to all resources applied by this module. | `map(string)` | `{}` | no | |
| 61 | +| <a name="input_enterprise_managed_user_suffix"></a> [enterprise_managed_user_suffix](#input_enterprise_managed_user_suffix) | Managed user suffix used for central identity management on GHEC | `string` | `""` | no | |
| 62 | +| <a name="input_enterprise_slug"></a> [enterprise_slug](#input_enterprise_slug) | The name (slug) of the enterprise on GHEC | `string` | n/a | yes | |
| 63 | +| <a name="input_extra_role_policy"></a> [extra_role_policy](#input_extra_role_policy) | jsonencoded string policy to include in the proxy lambda role | `string` | `null` | no | |
| 64 | +| <a name="input_lambda_bucket_name"></a> [lambda_bucket_name](#input_lambda_bucket_name) | S3 bucket with lambda and layer archives | `string` | n/a | yes | |
| 65 | +| <a name="input_lambda_layer_arn"></a> [lambda_layer_arn](#input_lambda_layer_arn) | Lambda layer ARN for data store | `string` | n/a | yes | |
| 66 | +| <a name="input_lambda_timeout_seconds"></a> [lambda_timeout_seconds](#input_lambda_timeout_seconds) | Number of seconds until lambda times out | `number` | `10` | no | |
| 67 | +| <a name="input_log_retention_days"></a> [log_retention_days](#input_log_retention_days) | Number of days CloudWatch will retain logs | `number` | `7` | no | |
| 68 | +| <a name="input_resource_prefix"></a> [resource_prefix](#input_resource_prefix) | Prefix of webhook proxy resources | `string` | `"gwp"` | no | |
| 69 | +| <a name="input_route_53_record_name"></a> [route_53_record_name](#input_route_53_record_name) | Record name for Route 53 record creation | `string` | `null` | no | |
| 70 | +| <a name="input_subnet_ids"></a> [subnet_ids](#input_subnet_ids) | subnet_ids for Lambda VPC config | `list(string)` | n/a | yes | |
| 71 | +| <a name="input_vpc_id"></a> [vpc_id](#input_vpc_id) | VPC id for Lambda VPC config | `string` | n/a | yes | |
| 72 | +| <a name="input_zone_id"></a> [zone_id](#input_zone_id) | Zone id for Route53 record | `string` | `null` | no | |
72 | 73 |
|
73 | 74 | ## Outputs |
74 | 75 |
|
75 | | -| Name | Description | |
76 | | -|------|-------------| |
77 | | -| <a name="output_apigateway_ingress_id"></a> [apigateway\_ingress\_id](#output\_apigateway\_ingress\_id) | n/a | |
78 | | -| <a name="output_apigateway_invoke_url"></a> [apigateway\_invoke\_url](#output\_apigateway\_invoke\_url) | n/a | |
| 76 | +| Name | Description | |
| 77 | +| -------------------------------------------------------------------------------------------------- | ----------- | |
| 78 | +| <a name="output_apigateway_ingress_id"></a> [apigateway_ingress_id](#output_apigateway_ingress_id) | n/a | |
| 79 | +| <a name="output_apigateway_invoke_url"></a> [apigateway_invoke_url](#output_apigateway_invoke_url) | n/a | |
| 80 | + |
79 | 81 | <!-- END_TF_DOCS --> |
0 commit comments