Skip to content

Commit f7cf606

Browse files
bryantbiggsbryantbiggs
authored
chore: update documentation and pin terraform_docs version to avoid future changes (#10)
1 parent a7812b9 commit f7cf606

File tree

4 files changed

+78
-69
lines changed

4 files changed

+78
-69
lines changed

‎.github/workflows/pre-commit.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ jobs:
9494
- name: Install pre-commit dependencies
9595
run: |
9696
pip install pre-commit
97-
curl -L "$(curl -s https://api.github.com/repos/terraform-docs/terraform-docs/releases/latest | grep -o -E "https://.+?-linux-amd64" | head -n1)" > terraform-docs && chmod +x terraform-docs && sudo mv terraform-docs /usr/bin/
97+
curl -L "$(curl -s https://api.github.com/repos/terraform-docs/terraform-docs/releases/latest | grep -o -E "https://.+?-v0.12.0-linux-amd64" | head -n1)" > terraform-docs && chmod +x terraform-docs && sudo mv terraform-docs /usr/bin/
9898
curl -L "$(curl -s https://api.github.com/repos/terraform-linters/tflint/releases/latest | grep -o -E "https://.+?_linux_amd64.zip")" > tflint.zip && unzip tflint.zip && rm tflint.zip && sudo mv tflint /usr/bin/
9999
- name: Execute pre-commit
100100
# Run all pre-commit checks on max version supported

‎.pre-commit-config.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
repos:
22
- repo: git://github.com/antonbabenko/pre-commit-terraform
3-
rev: v1.47.0
3+
rev: v1.48.0
44
hooks:
55
- id: terraform_fmt
66
- id: terraform_validate

‎README.md‎

Lines changed: 58 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -128,76 +128,85 @@ module "step_function" {
128128

129129
| Name | Version |
130130
|------|---------|
131-
| terraform | >= 0.13.1 |
132-
| aws | >= 3.27 |
131+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13.1 |
132+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.27 |
133133

134134
## Providers
135135

136136
| Name | Version |
137137
|------|---------|
138-
| aws | >= 3.27 |
138+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.27 |
139139

140140
## Modules
141141

142-
No Modules.
142+
No modules.
143143

144144
## Resources
145145

146-
| Name |
147-
|------|
148-
| [aws_iam_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) |
149-
| [aws_iam_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy_attachment) |
150-
| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) |
151-
| [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) |
152-
| [aws_iam_role_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) |
153-
| [aws_region](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) |
154-
| [aws_sfn_state_machine](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sfn_state_machine) |
146+
| Name | Type |
147+
|------|------|
148+
| [aws_iam_policy.additional_inline](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
149+
| [aws_iam_policy.additional_json](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
150+
| [aws_iam_policy.additional_jsons](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
151+
| [aws_iam_policy.service](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
152+
| [aws_iam_policy_attachment.additional_inline](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy_attachment) | resource |
153+
| [aws_iam_policy_attachment.additional_json](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy_attachment) | resource |
154+
| [aws_iam_policy_attachment.additional_jsons](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy_attachment) | resource |
155+
| [aws_iam_policy_attachment.service](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy_attachment) | resource |
156+
| [aws_iam_role.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
157+
| [aws_iam_role_policy_attachment.additional_many](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
158+
| [aws_iam_role_policy_attachment.additional_one](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
159+
| [aws_sfn_state_machine.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sfn_state_machine) | resource |
160+
| [aws_iam_policy_document.additional_inline](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
161+
| [aws_iam_policy_document.assume_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
162+
| [aws_iam_policy_document.service](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
163+
| [aws_region.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | data source |
155164

156165
## Inputs
157166

158167
| Name | Description | Type | Default | Required |
159168
|------|-------------|------|---------|:--------:|
160-
| attach\_policies | Controls whether list of policies should be added to IAM role | `bool` | `false` | no |
161-
| attach\_policies\_for\_integrations | Whether to attach AWS Service policies to IAM role | `bool` | `true` | no |
162-
| attach\_policy | Controls whether policy should be added to IAM role | `bool` | `false` | no |
163-
| attach\_policy\_json | Controls whether policy\_json should be added to IAM role | `bool` | `false` | no |
164-
| attach\_policy\_jsons | Controls whether policy\_jsons should be added to IAM role | `bool` | `false` | no |
165-
| attach\_policy\_statements | Controls whether policy\_statements should be added to IAM role | `bool` | `false` | no |
166-
| aws\_region\_assume\_role | Name of AWS regions where IAM role can be assumed by the Step Function | `string` | `""` | no |
167-
| create | Whether to create Step Function resource | `bool` | `true` | no |
168-
| create\_role | Whether to create IAM role for the Step Function | `bool` | `true` | no |
169-
| definition | The Amazon States Language definition of the Step Function | `string` | `""` | no |
170-
| name | The name of the Step Function | `string` | `""` | no |
171-
| number\_of\_policies | Number of policies to attach to IAM role | `number` | `0` | no |
172-
| number\_of\_policy\_jsons | Number of policies JSON to attach to IAM role | `number` | `0` | no |
173-
| policies | List of policy statements ARN to attach to IAM role | `list(string)` | `[]` | no |
174-
| policy | An additional policy document ARN to attach to IAM role | `string` | `null` | no |
175-
| policy\_json | An additional policy document as JSON to attach to IAM role | `string` | `null` | no |
176-
| policy\_jsons | List of additional policy documents as JSON to attach to IAM role | `list(string)` | `[]` | no |
177-
| policy\_statements | Map of dynamic policy statements to attach to IAM role | `any` | `{}` | no |
178-
| role\_arn | The Amazon Resource Name (ARN) of the IAM role to use for this Step Function | `string` | `""` | no |
179-
| role\_description | Description of IAM role to use for Step Function | `string` | `null` | no |
180-
| role\_force\_detach\_policies | Specifies to force detaching any policies the IAM role has before destroying it. | `bool` | `true` | no |
181-
| role\_name | Name of IAM role to use for Step Function | `string` | `null` | no |
182-
| role\_path | Path of IAM role to use for Step Function | `string` | `null` | no |
183-
| role\_permissions\_boundary | The ARN of the policy that is used to set the permissions boundary for the IAM role used by Step Function | `string` | `null` | no |
184-
| role\_tags | A map of tags to assign to IAM role | `map(string)` | `{}` | no |
185-
| service\_integrations | Map of AWS service integrations to allow in IAM role policy | `any` | `{}` | no |
186-
| tags | Maps of tags to assign to the Step Function | `map(string)` | `{}` | no |
187-
| trusted\_entities | Step Function additional trusted entities for assuming roles (trust relationship) | `list(string)` | `[]` | no |
188-
| type | Determines whether a Standard or Express state machine is created. The default is STANDARD. Valid Values: STANDARD \| EXPRESS | `string` | `"STANDARD"` | no |
189-
| use\_existing\_role | Whether to use an existing IAM role for this Step Function | `bool` | `false` | no |
169+
| <a name="input_attach_policies"></a> [attach\_policies](#input\_attach\_policies) | Controls whether list of policies should be added to IAM role | `bool` | `false` | no |
170+
| <a name="input_attach_policies_for_integrations"></a> [attach\_policies\_for\_integrations](#input\_attach\_policies\_for\_integrations) | Whether to attach AWS Service policies to IAM role | `bool` | `true` | no |
171+
| <a name="input_attach_policy"></a> [attach\_policy](#input\_attach\_policy) | Controls whether policy should be added to IAM role | `bool` | `false` | no |
172+
| <a name="input_attach_policy_json"></a> [attach\_policy\_json](#input\_attach\_policy\_json) | Controls whether policy\_json should be added to IAM role | `bool` | `false` | no |
173+
| <a name="input_attach_policy_jsons"></a> [attach\_policy\_jsons](#input\_attach\_policy\_jsons) | Controls whether policy\_jsons should be added to IAM role | `bool` | `false` | no |
174+
| <a name="input_attach_policy_statements"></a> [attach\_policy\_statements](#input\_attach\_policy\_statements) | Controls whether policy\_statements should be added to IAM role | `bool` | `false` | no |
175+
| <a name="input_aws_region_assume_role"></a> [aws\_region\_assume\_role](#input\_aws\_region\_assume\_role) | Name of AWS regions where IAM role can be assumed by the Step Function | `string` | `""` | no |
176+
| <a name="input_create"></a> [create](#input\_create) | Whether to create Step Function resource | `bool` | `true` | no |
177+
| <a name="input_create_role"></a> [create\_role](#input\_create\_role) | Whether to create IAM role for the Step Function | `bool` | `true` | no |
178+
| <a name="input_definition"></a> [definition](#input\_definition) | The Amazon States Language definition of the Step Function | `string` | `""` | no |
179+
| <a name="input_name"></a> [name](#input\_name) | The name of the Step Function | `string` | `""` | no |
180+
| <a name="input_number_of_policies"></a> [number\_of\_policies](#input\_number\_of\_policies) | Number of policies to attach to IAM role | `number` | `0` | no |
181+
| <a name="input_number_of_policy_jsons"></a> [number\_of\_policy\_jsons](#input\_number\_of\_policy\_jsons) | Number of policies JSON to attach to IAM role | `number` | `0` | no |
182+
| <a name="input_policies"></a> [policies](#input\_policies) | List of policy statements ARN to attach to IAM role | `list(string)` | `[]` | no |
183+
| <a name="input_policy"></a> [policy](#input\_policy) | An additional policy document ARN to attach to IAM role | `string` | `null` | no |
184+
| <a name="input_policy_json"></a> [policy\_json](#input\_policy\_json) | An additional policy document as JSON to attach to IAM role | `string` | `null` | no |
185+
| <a name="input_policy_jsons"></a> [policy\_jsons](#input\_policy\_jsons) | List of additional policy documents as JSON to attach to IAM role | `list(string)` | `[]` | no |
186+
| <a name="input_policy_statements"></a> [policy\_statements](#input\_policy\_statements) | Map of dynamic policy statements to attach to IAM role | `any` | `{}` | no |
187+
| <a name="input_role_arn"></a> [role\_arn](#input\_role\_arn) | The Amazon Resource Name (ARN) of the IAM role to use for this Step Function | `string` | `""` | no |
188+
| <a name="input_role_description"></a> [role\_description](#input\_role\_description) | Description of IAM role to use for Step Function | `string` | `null` | no |
189+
| <a name="input_role_force_detach_policies"></a> [role\_force\_detach\_policies](#input\_role\_force\_detach\_policies) | Specifies to force detaching any policies the IAM role has before destroying it. | `bool` | `true` | no |
190+
| <a name="input_role_name"></a> [role\_name](#input\_role\_name) | Name of IAM role to use for Step Function | `string` | `null` | no |
191+
| <a name="input_role_path"></a> [role\_path](#input\_role\_path) | Path of IAM role to use for Step Function | `string` | `null` | no |
192+
| <a name="input_role_permissions_boundary"></a> [role\_permissions\_boundary](#input\_role\_permissions\_boundary) | The ARN of the policy that is used to set the permissions boundary for the IAM role used by Step Function | `string` | `null` | no |
193+
| <a name="input_role_tags"></a> [role\_tags](#input\_role\_tags) | A map of tags to assign to IAM role | `map(string)` | `{}` | no |
194+
| <a name="input_service_integrations"></a> [service\_integrations](#input\_service\_integrations) | Map of AWS service integrations to allow in IAM role policy | `any` | `{}` | no |
195+
| <a name="input_tags"></a> [tags](#input\_tags) | Maps of tags to assign to the Step Function | `map(string)` | `{}` | no |
196+
| <a name="input_trusted_entities"></a> [trusted\_entities](#input\_trusted\_entities) | Step Function additional trusted entities for assuming roles (trust relationship) | `list(string)` | `[]` | no |
197+
| <a name="input_type"></a> [type](#input\_type) | Determines whether a Standard or Express state machine is created. The default is STANDARD. Valid Values: STANDARD \| EXPRESS | `string` | `"STANDARD"` | no |
198+
| <a name="input_use_existing_role"></a> [use\_existing\_role](#input\_use\_existing\_role) | Whether to use an existing IAM role for this Step Function | `bool` | `false` | no |
190199

191200
## Outputs
192201

193202
| Name | Description |
194203
|------|-------------|
195-
| this\_role\_arn | The ARN of the IAM role created for the Step Function |
196-
| this\_role\_name | The name of the IAM role created for the Step Function |
197-
| this\_state\_machine\_arn | The ARN of the Step Function |
198-
| this\_state\_machine\_creation\_date | The date the Step Function was created |
199-
| this\_state\_machine\_id | The ARN of the Step Function |
200-
| this\_state\_machine\_status | The current status of the Step Function |
204+
| <a name="output_this_role_arn"></a> [this\_role\_arn](#output\_this\_role\_arn) | The ARN of the IAM role created for the Step Function |
205+
| <a name="output_this_role_name"></a> [this\_role\_name](#output\_this\_role\_name) | The name of the IAM role created for the Step Function |
206+
| <a name="output_this_state_machine_arn"></a> [this\_state\_machine\_arn](#output\_this\_state\_machine\_arn) | The ARN of the Step Function |
207+
| <a name="output_this_state_machine_creation_date"></a> [this\_state\_machine\_creation\_date](#output\_this\_state\_machine\_creation\_date) | The date the Step Function was created |
208+
| <a name="output_this_state_machine_id"></a> [this\_state\_machine\_id](#output\_this\_state\_machine\_id) | The ARN of the Step Function |
209+
| <a name="output_this_state_machine_status"></a> [this\_state\_machine\_status](#output\_this\_state\_machine\_status) | The current status of the Step Function |
201210
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
202211

203212
## Authors

‎examples/complete/README.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -22,43 +22,43 @@ Note that this example may create resources which cost money. Run `terraform des
2222

2323
| Name | Version |
2424
|------|---------|
25-
| terraform | >= 0.13.1 |
26-
| aws | >= 3.27 |
27-
| random | >= 2 |
25+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13.1 |
26+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.27 |
27+
| <a name="requirement_random"></a> [random](#requirement\_random) | >= 2 |
2828

2929
## Providers
3030

3131
| Name | Version |
3232
|------|---------|
33-
| aws | >= 3.27 |
34-
| random | >= 2 |
33+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.27 |
34+
| <a name="provider_random"></a> [random](#provider\_random) | >= 2 |
3535

3636
## Modules
3737

3838
| Name | Source | Version |
3939
|------|--------|---------|
40-
| disabled_step_function | ../../ | |
41-
| step_function | ../../ | |
40+
| <a name="module_disabled_step_function"></a> [disabled\_step\_function](#module\_disabled\_step\_function) | ../../ | |
41+
| <a name="module_step_function"></a> [step\_function](#module\_step\_function) | ../../ | |
4242

4343
## Resources
4444

45-
| Name |
46-
|------|
47-
| [aws_sqs_queue](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sqs_queue) |
48-
| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) |
45+
| Name | Type |
46+
|------|------|
47+
| [aws_sqs_queue.queue](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sqs_queue) | resource |
48+
| [random_pet.this](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) | resource |
4949

5050
## Inputs
5151

52-
No input.
52+
No inputs.
5353

5454
## Outputs
5555

5656
| Name | Description |
5757
|------|-------------|
58-
| this\_role\_arn | The ARN of the IAM role created for the State Machine |
59-
| this\_role\_name | The name of the IAM role created for the State Machine |
60-
| this\_state\_machine\_arn | The ARN of the State Machine |
61-
| this\_state\_machine\_creation\_date | The date the State Machine was created |
62-
| this\_state\_machine\_id | The ARN of the State Machine |
63-
| this\_state\_machine\_status | The current status of the State Machine |
58+
| <a name="output_this_role_arn"></a> [this\_role\_arn](#output\_this\_role\_arn) | The ARN of the IAM role created for the State Machine |
59+
| <a name="output_this_role_name"></a> [this\_role\_name](#output\_this\_role\_name) | The name of the IAM role created for the State Machine |
60+
| <a name="output_this_state_machine_arn"></a> [this\_state\_machine\_arn](#output\_this\_state\_machine\_arn) | The ARN of the State Machine |
61+
| <a name="output_this_state_machine_creation_date"></a> [this\_state\_machine\_creation\_date](#output\_this\_state\_machine\_creation\_date) | The date the State Machine was created |
62+
| <a name="output_this_state_machine_id"></a> [this\_state\_machine\_id](#output\_this\_state\_machine\_id) | The ARN of the State Machine |
63+
| <a name="output_this_state_machine_status"></a> [this\_state\_machine\_status](#output\_this\_state\_machine\_status) | The current status of the State Machine |
6464
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

0 commit comments

Comments
 (0)