|
1 | | -# Usage |
2 | | - |
3 | | -<!--- BEGIN_TF_DOCS ---> |
4 | | -## Requirements |
5 | | - |
6 | | -| Name | Version | |
7 | | -|------|---------| |
8 | | -| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | 1.0.11 | |
9 | | - |
10 | | -## Providers |
11 | | - |
12 | | -| Name | Version | |
13 | | -|------|---------| |
14 | | -| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a | |
15 | | -| <a name="provider_terraform"></a> [terraform](#provider\_terraform) | n/a | |
16 | | - |
17 | | -## Modules |
18 | | - |
19 | | -No modules. |
20 | | - |
21 | | -## Resources |
22 | | - |
23 | | -| Name | Type | |
24 | | -|------|------| |
25 | | -| [aws_api_gateway_base_path_mapping.dns_mapping](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_base_path_mapping) | resource | |
26 | | -| [aws_api_gateway_deployment.ingress](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_deployment) | resource | |
27 | | -| [aws_api_gateway_domain_name.proxy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_domain_name) | resource | |
28 | | -| [aws_api_gateway_integration.lambda](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_integration) | resource | |
29 | | -| [aws_api_gateway_method.lambda_method](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_method) | resource | |
30 | | -| [aws_api_gateway_method_settings.log_settings](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_method_settings) | resource | |
31 | | -| [aws_api_gateway_resource.lambda_endpoint](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_resource) | resource | |
32 | | -| [aws_api_gateway_resource.webhook](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_resource) | resource | |
33 | | -| [aws_api_gateway_rest_api.ingress_api](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_rest_api) | resource | |
34 | | -| [aws_api_gateway_rest_api_policy.allow_list](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_rest_api_policy) | resource | |
35 | | -| [aws_api_gateway_stage.ingress](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_stage) | resource | |
36 | | -| [aws_cloudwatch_dashboard.metrics](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_dashboard) | resource | |
37 | | -| [aws_cloudwatch_log_group.apigw](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | resource | |
38 | | -| [aws_cloudwatch_log_group.lambda](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | resource | |
39 | | -| [aws_iam_role.proxy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource | |
40 | | -| [aws_iam_role_policy.apigw_logging](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | resource | |
41 | | -| [aws_iam_role_policy.datadog_trace](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | resource | |
42 | | -| [aws_iam_role_policy.lambda](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | resource | |
43 | | -| [aws_iam_role_policy_attachment.basic_execution](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource | |
44 | | -| [aws_iam_role_policy_attachment.vpc_execution](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource | |
45 | | -| [aws_lambda_function.proxy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_function) | resource | |
46 | | -| [aws_lambda_layer_version.proxy_layer](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_layer_version) | resource | |
47 | | -| [aws_lambda_permission.apigw_lambda](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_permission) | resource | |
48 | | -| [aws_route53_record.proxy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource | |
49 | | -| [aws_security_group.lambda](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource | |
50 | | -| [aws_acm_certificate.certificate](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/acm_certificate) | data source | |
51 | | -| [aws_iam_policy_document.allow_list](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | |
52 | | -| [aws_iam_policy_document.apigw_logging](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | |
53 | | -| [aws_iam_policy_document.datadog_trace](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | |
54 | | -| [aws_iam_policy_document.lambda_logging](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | |
55 | | -| [aws_iam_policy_document.proxy_service](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source | |
56 | | -| [aws_s3_bucket_object.proxy_lambda](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/s3_bucket_object) | data source | |
57 | | -| [aws_s3_bucket_object.proxy_lambda_layer](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/s3_bucket_object) | data source | |
58 | | -| [aws_subnets.subnets](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/subnets) | data source | |
59 | | -| [aws_vpc.vpc](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc) | data source | |
60 | | -| [terraform_remote_state.global](https://registry.terraform.io/providers/hashicorp/terraform/latest/docs/data-sources/remote_state) | data source | |
61 | | - |
62 | | -## Inputs |
63 | | - |
64 | | -| Name | Description | Type | Default | Required | |
65 | | -|------|-------------|------|---------|:--------:| |
66 | | -| <a name="input_aws_account_id"></a> [aws\_account\_id](#input\_aws\_account\_id) | The AWS account id | `string` | n/a | yes | |
67 | | -| <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 | |
68 | | -| <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 | |
69 | | -| <a name="input_default_tags"></a> [default\_tags](#input\_default\_tags) | A map of default tags to add to all resources applied by this module | `map(string)` | <pre>{<br> "Application": "github-webhook-proxy",<br> "ApplicationStack": "EG GitHub",<br> "Team": "Delivery Platform",<br> "terraform-module": "github-webhook-proxy"<br>}</pre> | no | |
70 | | -| <a name="input_eg_flavor"></a> [eg\_flavor](#input\_eg\_flavor) | The Kumo deployment flavor | `string` | `"default"` | no | |
71 | | -| <a name="input_eg_security_context"></a> [eg\_security\_context](#input\_eg\_security\_context) | The security context | `string` | n/a | yes | |
72 | | -| <a name="input_eg_segment"></a> [eg\_segment](#input\_eg\_segment) | The AWS segment | `string` | n/a | yes | |
73 | | -| <a name="input_eg_segment_state_bucket"></a> [eg\_segment\_state\_bucket](#input\_eg\_segment\_state\_bucket) | Kumo managed bucket containing Terraform state for segment | `string` | n/a | yes | |
74 | | -| <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` | `null` | no | |
75 | | -| <a name="input_lambda_timeout_seconds"></a> [lambda\_timeout\_seconds](#input\_lambda\_timeout\_seconds) | Number of seconds until lambda times out | `number` | `10` | no | |
76 | | -| <a name="input_log_retention_days"></a> [log\_retention\_days](#input\_log\_retention\_days) | Number of days CloudWatch will retain logs | `number` | `7` | no | |
77 | | -| <a name="input_name_prefix"></a> [name\_prefix](#input\_name\_prefix) | Used to prefix resource names | `string` | `"gwp"` | no | |
78 | | -| <a name="input_terraform_module_version"></a> [terraform\_module\_version](#input\_terraform\_module\_version) | Module vars | `string` | n/a | yes | |
79 | | - |
80 | | -## Outputs |
81 | | - |
82 | | -| Name | Description | |
83 | | -|------|-------------| |
84 | | -| <a name="output_apigateway_ingress_id"></a> [apigateway\_ingress\_id](#output\_apigateway\_ingress\_id) | n/a | |
85 | | -| <a name="output_apigateway_invoke_url"></a> [apigateway\_invoke\_url](#output\_apigateway\_invoke\_url) | n/a | |
86 | | - |
87 | | -<!--- END_TF_DOCS ---> |
88 | | - |
89 | | - |
90 | 1 | <!-- BEGIN_TF_DOCS --> |
91 | 2 | ## Requirements |
92 | 3 |
|
@@ -165,4 +76,4 @@ No modules. |
165 | 76 | |------|-------------| |
166 | 77 | | <a name="output_apigateway_ingress_id"></a> [apigateway\_ingress\_id](#output\_apigateway\_ingress\_id) | n/a | |
167 | 78 | | <a name="output_apigateway_invoke_url"></a> [apigateway\_invoke\_url](#output\_apigateway\_invoke\_url) | n/a | |
168 | | -<!-- END_TF_DOCS --> |
| 79 | +<!-- END_TF_DOCS --> |
0 commit comments