USAGE.md

Requirements

Name	Version
terraform	1.14.4

Providers

Name	Version
aws	n/a

Modules

No modules.

Resources

Name	Type
aws_api_gateway_base_path_mapping.dns_mapping	resource
aws_api_gateway_deployment.ingress	resource
aws_api_gateway_domain_name.proxy	resource
aws_api_gateway_integration.lambda	resource
aws_api_gateway_method.lambda_method	resource
aws_api_gateway_method_settings.log_settings	resource
aws_api_gateway_resource.lambda_endpoint	resource
aws_api_gateway_resource.webhook	resource
aws_api_gateway_rest_api.ingress_api	resource
aws_api_gateway_rest_api_policy.allow_list	resource
aws_api_gateway_stage.ingress	resource
aws_cloudwatch_dashboard.metrics	resource
aws_cloudwatch_log_group.apigw	resource
aws_cloudwatch_log_group.lambda	resource
aws_iam_role.proxy	resource
aws_iam_role_policy.apigw_logging	resource
aws_iam_role_policy.extra_policy	resource
aws_iam_role_policy.lambda	resource
aws_iam_role_policy_attachment.basic_execution	resource
aws_iam_role_policy_attachment.vpc_execution	resource
aws_lambda_function.proxy	resource
aws_lambda_permission.apigw_lambda	resource
aws_route53_record.proxy	resource
aws_security_group.lambda	resource
aws_iam_policy_document.allow_list	data source
aws_iam_policy_document.apigw_logging	data source
aws_iam_policy_document.lambda_logging	data source
aws_iam_policy_document.proxy_service	data source
aws_s3_object.proxy_lambda	data source

Inputs

Name	Description	Type	Default	Required
api_gateway_domain_name	Domain name for API gateway domain mapping	string	null	no
aws_region	The AWS region to deploy to (e.g. us-east-1)	string	n/a	yes
certificate_arn	Certificate ARN for API gateway domain name	string	null	no
custom_tags	Additional tags to be applied to all resources applied by this module.	map(string)	{}	no
enterprise_managed_user_suffix	Managed user suffix used for central identity management on GHEC	string	""	no
enterprise_slug	The name (slug) of the enterprise on GHEC	string	n/a	yes
extra_role_policy	jsonencoded string policy to include in the proxy lambda role	string	null	no
lambda_bucket_name	S3 bucket with lambda and layer archives	string	n/a	yes
lambda_layer_arn	Lambda layer ARN for data store	string	n/a	yes
lambda_timeout_seconds	Number of seconds until lambda times out	number	10	no
log_retention_days	Number of days CloudWatch will retain logs	number	7	no
resource_prefix	Prefix of webhook proxy resources	string	"gwp"	no
route_53_record_name	Record name for Route 53 record creation	string	null	no
subnet_ids	subnet_ids for Lambda VPC config	list(string)	n/a	yes
vpc_id	VPC id for Lambda VPC config	string	n/a	yes
zone_id	Zone id for Route53 record	string	null	no

Outputs

Name	Description
apigateway_ingress_id	n/a
apigateway_invoke_url	n/a