Skip to content

Commit 5b969cf

Browse files
committed
example naming has been improved
1 parent df2b01a commit 5b969cf

File tree

2 files changed

+18
-23
lines changed

2 files changed

+18
-23
lines changed

example/README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,13 @@ terraform destroy
2626

2727
| Input Variable | Type | Description | Required? |
2828
|:-------------------------- |:-------:|:------------------------------------------------------------- |:--------------:|
29-
| **in_role_arn** | String | The VPC's Cidr defining the range of available IP addresses | optional |
29+
| **in_role_arn** | String | Pass if using an IAM role as the AWS access mechanism. | optional |
3030

3131
### What is the role arn?
3232

3333
If you are using an IAM role as the AWS access mechanism then pass it as in_role_arn commonly through an environment variable named **TF_VAR_in_role_arn** in addition to the usual AWS access key, secret key and default region parameters.
3434

35-
| -- Individuals and small businesses who don't have hundreds of AWS
36-
| -- accounts can omit the variable and thanks to dynamic assignment
37-
| -- the assume_role block will cease to exist.
38-
35+
Individuals and small businesses who don't have hundreds of AWS accounts can omit the variable and thanks to dynamic assignment the assume_role block will cease to exist.
3936

4037

4138
## Related Modules

example/vpc.network-test.tf renamed to example/vpc.network-example.tf

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
### Example VPC Networks ###
44
### #################### ###
55

6-
module subnet-count-not-stated {
6+
module vpc-net {
77

88
source = "./.."
9-
in_ecosystem = local.ecosystem_name
10-
in_timestamp = local.timestamp
11-
in_description = local.description
9+
in_ecosystem = "${ local.ecosystem_name }-00"
10+
in_timestamp = local.timestamp
11+
in_description = local.description
1212
}
1313

1414

@@ -20,9 +20,9 @@ module just-two-subnets {
2020
in_num_public_subnets = 2
2121
in_subnets_max = "7"
2222

23-
in_ecosystem = "${ local.ecosystem_name }-01"
24-
in_timestamp = local.timestamp
25-
in_description = local.description
23+
in_ecosystem = "${ local.ecosystem_name }-01"
24+
in_timestamp = local.timestamp
25+
in_description = local.description
2626
}
2727

2828

@@ -35,9 +35,9 @@ module no-private-subnets {
3535
in_num_public_subnets = 2
3636
in_create_public_gateway = false
3737

38-
in_ecosystem = "${ local.ecosystem_name }-02"
39-
in_timestamp = local.timestamp
40-
in_description = local.description
38+
in_ecosystem = "${ local.ecosystem_name }-02"
39+
in_timestamp = local.timestamp
40+
in_description = local.description
4141
}
4242

4343

@@ -50,19 +50,19 @@ module two-subnets-per-zone {
5050
in_create_public_gateway = false
5151
in_create_private_gateway = false
5252

53-
in_ecosystem = "${ local.ecosystem_name }-03"
54-
in_timestamp = local.timestamp
55-
in_description = local.description
53+
in_ecosystem = "${ local.ecosystem_name }-03"
54+
in_timestamp = local.timestamp
55+
in_description = local.description
5656
}
5757

5858

5959
### ########################### ###
6060
### Example VPC Network Outputs ###
6161
### ########################### ###
6262

63-
output subnet_ids_1{ value = module.subnet-count-not-stated.out_subnet_ids }
64-
output private_subnet_ids_1{ value = module.subnet-count-not-stated.out_private_subnet_ids }
65-
output public_subnet_ids_1{ value = module.subnet-count-not-stated.out_public_subnet_ids }
63+
output subnet_ids_1{ value = module.vpc-net.out_subnet_ids }
64+
output private_subnet_ids_1{ value = module.vpc-net.out_private_subnet_ids }
65+
output public_subnet_ids_1{ value = module.vpc-net.out_public_subnet_ids }
6666

6767
output subnet_ids_2{ value = module.just-two-subnets.out_subnet_ids }
6868
output private_subnet_ids_2{ value = module.just-two-subnets.out_private_subnet_ids }
@@ -76,7 +76,6 @@ output subnet_ids_4{ value = module.two-subnets-per-zone.out_subnet_ids }
7676
output private_subnet_ids_4{ value = module.two-subnets-per-zone.out_private_subnet_ids }
7777
output public_subnet_ids_4{ value = module.two-subnets-per-zone.out_public_subnet_ids }
7878

79-
8079
/*
8180
| --
8281
| -- If you are using an IAM role as the AWS access mechanism then
@@ -97,7 +96,6 @@ provider aws {
9796
}
9897
}
9998

100-
10199
variable in_role_arn {
102100
description = "The Role ARN to use when we assume role to implement the provisioning."
103101
default = ""

0 commit comments

Comments
 (0)