Skip to content

Commit 4562272

Browse files
committed
chore: docs
1 parent 4bb903f commit 4562272

File tree

3 files changed

+53
-11
lines changed

3 files changed

+53
-11
lines changed

modules/emr/README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
## Providers
2+
3+
The following providers are used by this module:
4+
5+
- aws
6+
17
## Required Inputs
28

39
The following input variables are required:
@@ -18,6 +24,14 @@ Type: `string`
1824

1925
The following input variables are optional (have default values):
2026

27+
### cluster\_name
28+
29+
Description: Name of the EMR cluster that the module creates
30+
31+
Type: `string`
32+
33+
Default: `"segment-data-lake"`
34+
2135
### master\_security\_group
2236

2337
Description: Identifier of the Amazon EC2 EMR-Managed security group for the master node.
@@ -40,12 +54,9 @@ Description: A map of tags to add to all resources. A vendor=segment tag will be
4054

4155
Type: `map`
4256

43-
Default: `<map>`
57+
Default: `{}`
4458

45-
### cluster\_name
46-
47-
Description: Name of the EMR cluster that is created.
59+
## Outputs
4860

49-
Type: `string`
61+
No output.
5062

51-
Default: `"segment-data-lake"`

modules/glue/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
## Providers
2+
3+
The following providers are used by this module:
4+
5+
- aws
6+
17
## Required Inputs
28

39
The following input variables are required:
@@ -20,3 +26,11 @@ Type: `string`
2026

2127
Default: `"Segment Data Lake"`
2228

29+
## Outputs
30+
31+
The following outputs are exported:
32+
33+
### database\_name
34+
35+
Description: n/a
36+

modules/iam/README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
## Providers
2+
3+
The following providers are used by this module:
4+
5+
- aws
6+
17
## Required Inputs
28

39
The following input variables are required:
@@ -34,19 +40,30 @@ Type: `string`
3440

3541
Default: `"segment-data-lake-role"`
3642

37-
### segment\_aws\_account
43+
### segment\_aws\_accounts
3844

39-
Description: ARN of the AWS account used by Segment to connect to your Data Lake.
45+
Description: ARN of the AWS accounts used by Segment to connect to your Data Lake.
4046

41-
Type: `string`
47+
Type: `list`
48+
49+
Default:
4250

43-
Default: `"arn:aws:iam::798609480926:root"`
51+
```json
52+
[
53+
"arn:aws:iam::798609480926:root",
54+
"arn:aws:iam::294048959147:root"
55+
]
56+
```
4457

4558
### tags
4659

4760
Description: A map of tags to add to all resources. A vendor=segment tag will be added automatically.
4861

4962
Type: `map`
5063

51-
Default: `<map>`
64+
Default: `{}`
65+
66+
## Outputs
67+
68+
No output.
5269

0 commit comments

Comments
 (0)