Skip to content

Commit 8196dbd

Browse files
github-actions[bot]Benjamin Valiente (Contractor)
authored andcommitted
terraform-docs: automated action
1 parent 894ed13 commit 8196dbd

4 files changed

Lines changed: 53 additions & 4 deletions

File tree

aws/network/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ module "network" {
7171
| <a name="module_private_subnets"></a> [private\_subnets](#module\_private\_subnets) | ./modules/private-subnets | n/a |
7272
| <a name="module_public_subnet_routes"></a> [public\_subnet\_routes](#module\_public\_subnet\_routes) | ./modules/public-subnet-routes | n/a |
7373
| <a name="module_public_subnets"></a> [public\_subnets](#module\_public\_subnets) | ./modules/public-subnets | n/a |
74+
| <a name="module_s3_endpoint"></a> [s3\_endpoint](#module\_s3\_endpoint) | ./modules/vpc-endpoints/s3-vpc-endpoint | n/a |
7475
| <a name="module_vpc"></a> [vpc](#module\_vpc) | ./modules/vpc | n/a |
7576

7677
## Resources
@@ -87,6 +88,7 @@ module "network" {
8788
| <a name="input_cluster_names"></a> [cluster\_names](#input\_cluster\_names) | List of clusters which run in this network | `list(string)` | `[]` | no |
8889
| <a name="input_create_internet_gateway"></a> [create\_internet\_gateway](#input\_create\_internet\_gateway) | Set to false to disable creation of an internet gateway | `bool` | `true` | no |
8990
| <a name="input_create_nat_gateways"></a> [create\_nat\_gateways](#input\_create\_nat\_gateways) | Set to false to disable creation of NAT gateways | `bool` | `true` | no |
91+
| <a name="input_create_s3_endpoint"></a> [create\_s3\_endpoint](#input\_create\_s3\_endpoint) | Set to false to disable creation of the S3 Gateway VPC endpoint | `bool` | `true` | no |
9092
| <a name="input_create_vpc"></a> [create\_vpc](#input\_create\_vpc) | Set to false to disable creation of the VPC | `bool` | `true` | no |
9193
| <a name="input_enable_flow_logs"></a> [enable\_flow\_logs](#input\_enable\_flow\_logs) | Set to true to enable VPC flow logs | `bool` | `false` | no |
9294
| <a name="input_enable_ipv6"></a> [enable\_ipv6](#input\_enable\_ipv6) | Set to false to disable IPV6 | `bool` | `false` | no |
@@ -109,5 +111,6 @@ module "network" {
109111
|------|-------------|
110112
| <a name="output_cluster_names"></a> [cluster\_names](#output\_cluster\_names) | List of clusters which run in this network |
111113
| <a name="output_nat_ip_addresses"></a> [nat\_ip\_addresses](#output\_nat\_ip\_addresses) | List of IP addresses created for NAT gateways |
114+
| <a name="output_s3_endpoint_id"></a> [s3\_endpoint\_id](#output\_s3\_endpoint\_id) | ID of the S3 Gateway VPC endpoint (null if disabled) |
112115
| <a name="output_vpc_id"></a> [vpc\_id](#output\_vpc\_id) | ID of the AWS VPC |
113116
<!-- END_TF_DOCS -->

aws/network/modules/private-subnet-routes/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,11 @@
3131
| <a name="input_private_subnets"></a> [private\_subnets](#input\_private\_subnets) | Private subnets for each availability\_zone | `map(object({ id = string, availability_zone = string }))` | n/a | yes |
3232
| <a name="input_tags"></a> [tags](#input\_tags) | Tags to be applied to all created resources | `map(string)` | `{}` | no |
3333
| <a name="input_vpc"></a> [vpc](#input\_vpc) | AWS VPC for NAT gateways | `object({ id = string, cidr_block = string })` | n/a | yes |
34+
35+
## Outputs
36+
37+
| Name | Description |
38+
|------|-------------|
39+
| <a name="output_route_table_ids"></a> [route\_table\_ids](#output\_route\_table\_ids) | List of route table IDs for private subnets |
40+
| <a name="output_route_tables"></a> [route\_tables](#output\_route\_tables) | Map of per-AZ NAT route tables for private subnets |
3441
<!-- END_TF_DOCS -->
Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,40 @@
11
# AWS S3 VPC Endpoint
22

3-
Module for creating a S3 VPC Endpoint in AWS.
3+
Module for creating a S3 VPC Endpoint in AWS.
4+
<!-- BEGIN_TF_DOCS -->
5+
## Requirements
6+
7+
| Name | Version |
8+
|------|---------|
9+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.6.2 |
10+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 6.0 |
11+
12+
## Providers
13+
14+
| Name | Version |
15+
|------|---------|
16+
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 6.0 |
17+
18+
## Resources
19+
20+
| Name | Type |
21+
|------|------|
22+
| [aws_vpc_endpoint.s3](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/vpc_endpoint) | resource |
23+
24+
## Inputs
25+
26+
| Name | Description | Type | Default | Required |
27+
|------|-------------|------|---------|:--------:|
28+
| <a name="input_name"></a> [name](#input\_name) | Name for this network (used in the endpoint's Name tag) | `string` | n/a | yes |
29+
| <a name="input_namespace"></a> [namespace](#input\_namespace) | Prefix to be applied to created resources | `list(string)` | `[]` | no |
30+
| <a name="input_route_table_ids"></a> [route\_table\_ids](#input\_route\_table\_ids) | List of route table IDs to associate with the S3 Gateway endpoint | `list(string)` | n/a | yes |
31+
| <a name="input_tags"></a> [tags](#input\_tags) | Tags to be applied to the endpoint | `map(string)` | `{}` | no |
32+
| <a name="input_vpc"></a> [vpc](#input\_vpc) | The VPC object in which to create the S3 endpoint | <pre>object({<br> id = string<br> })</pre> | n/a | yes |
33+
34+
## Outputs
35+
36+
| Name | Description |
37+
|------|-------------|
38+
| <a name="output_endpoint_id"></a> [endpoint\_id](#output\_endpoint\_id) | ID of the S3 Gateway VPC endpoint |
39+
| <a name="output_prefix_list_id"></a> [prefix\_list\_id](#output\_prefix\_list\_id) | Prefix list ID of the S3 endpoint (useful for security group egress rules) |
40+
<!-- END_TF_DOCS -->
Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1+
data "aws_region" "current" {}
2+
13
resource "aws_vpc_endpoint" "s3" {
2-
vpc_id = var.vpc_id
3-
service_name = "com.amazonaws.${var.region}.s3"
4+
vpc_id = var.vpc.id
5+
service_name = "com.amazonaws.${data.aws_region.current.name}.s3"
46
vpc_endpoint_type = "Gateway"
57

68
route_table_ids = var.route_table_ids
79

810
tags = merge(
911
var.tags,
1012
{
11-
Name = "${var.name}-s3-endpoint"
13+
Name = join("-", concat(var.namespace, [var.name, "s3-endpoint"]))
1214
}
1315
)
1416
}

0 commit comments

Comments
 (0)