Skip to content

Commit 61ef4b9

Browse files
terraform-docs: automated action
1 parent 619017a commit 61ef4b9

File tree

1 file changed

+30
-5
lines changed

1 file changed

+30
-5
lines changed

README.md

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -89,25 +89,50 @@ tf -c=aws destroy -var='teamid=foo' -var='prjid=bar'
8989
<!-- BEGIN_TF_DOCS -->
9090
## Requirements
9191

92-
No requirements.
92+
| Name | Version |
93+
|------|---------|
94+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.1 |
95+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 3.74 |
9396

9497
## Providers
9598

96-
No providers.
99+
| Name | Version |
100+
|------|---------|
101+
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 3.74 |
97102

98103
## Modules
99104

100105
No modules.
101106

102107
## Resources
103108

104-
No resources.
109+
| Name | Type |
110+
|------|------|
111+
| [aws_cloudwatch_event_rule.event_rule](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_event_rule) | resource |
112+
| [aws_cloudwatch_event_target.event_target_input_type](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_event_target) | resource |
105113

106114
## Inputs
107115

108-
No inputs.
116+
| Name | Description | Type | Default | Required |
117+
|------|-------------|------|---------|:--------:|
118+
| <a name="input_branch"></a> [branch](#input\_branch) | branch to use for cicd | `string` | `"main"` | no |
119+
| <a name="input_custom_input"></a> [custom\_input](#input\_custom\_input) | custom input to be included in generated events | `map(any)` | `null` | no |
120+
| <a name="input_deploy_event_rule"></a> [deploy\_event\_rule](#input\_deploy\_event\_rule) | Feature flag, true or false | `bool` | `true` | no |
121+
| <a name="input_deploy_event_target"></a> [deploy\_event\_target](#input\_deploy\_event\_target) | Feature flag, true or false | `bool` | `true` | no |
122+
| <a name="input_description"></a> [description](#input\_description) | description for the cloudwatch event | `string` | `null` | no |
123+
| <a name="input_name"></a> [name](#input\_name) | Cloudwatch event rule name | `string` | `null` | no |
124+
| <a name="input_prjid"></a> [prjid](#input\_prjid) | Name of the project/stack e.g: mystack, nifieks, demoaci. Should not be changed after running 'tf apply' | `string` | n/a | yes |
125+
| <a name="input_schedule"></a> [schedule](#input\_schedule) | schedule for the cloudwatch event | `string` | `"rate(1 day)"` | no |
126+
| <a name="input_service_role"></a> [service\_role](#input\_service\_role) | service role to be used by cicd | `string` | `null` | no |
127+
| <a name="input_suffix"></a> [suffix](#input\_suffix) | suffix to be added to cloudwatch rule name | `string` | `"rule"` | no |
128+
| <a name="input_target_arn"></a> [target\_arn](#input\_target\_arn) | target arn | `string` | n/a | yes |
129+
| <a name="input_teamid"></a> [teamid](#input\_teamid) | Name of the team/group e.g. devops, dataengineering. Should not be changed after running 'tf apply' | `string` | n/a | yes |
130+
| <a name="input_timeout"></a> [timeout](#input\_timeout) | timeout for cloudwatch event | `number` | `60` | no |
109131

110132
## Outputs
111133

112-
No outputs.
134+
| Name | Description |
135+
|------|-------------|
136+
| <a name="output_cloudwatch_event_rule_arn"></a> [cloudwatch\_event\_rule\_arn](#output\_cloudwatch\_event\_rule\_arn) | The cloudwatch event rule ARN |
137+
| <a name="output_cloudwatch_event_target_arn"></a> [cloudwatch\_event\_target\_arn](#output\_cloudwatch\_event\_target\_arn) | The cloudwatch event target ARN |
113138
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)