Skip to content

Commit d8b1628

Browse files
docs: auto update terraform docs
1 parent bdda79d commit d8b1628

2 files changed

Lines changed: 8 additions & 5 deletions

File tree

modules/runners/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ yarn run dist
237237
| <a name="output_role_pool"></a> [role\_pool](#output\_role\_pool) | n/a |
238238
| <a name="output_role_runner"></a> [role\_runner](#output\_role\_runner) | n/a |
239239
| <a name="output_role_scale_down"></a> [role\_scale\_down](#output\_role\_scale\_down) | n/a |
240-
| <a name="output_scale_down_ssm_parameters"></a> [scale\_down\_ssm\_parameters](#output\_scale\_down\_ssm\_parameters) | n/a |
241240
| <a name="output_role_scale_up"></a> [role\_scale\_up](#output\_role\_scale\_up) | n/a |
242241
| <a name="output_runners_log_groups"></a> [runners\_log\_groups](#output\_runners\_log\_groups) | List of log groups from different log files of runner machine. |
242+
| <a name="output_scale_down_ssm_parameters"></a> [scale\_down\_ssm\_parameters](#output\_scale\_down\_ssm\_parameters) | n/a |
243243
<!-- END_TF_DOCS -->

modules/runners/scale-down/README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,11 @@ No modules.
3737
| [aws_iam_role_policy_attachment.scale_down_vpc_execution_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
3838
| [aws_lambda_function.scale_down](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_function) | resource |
3939
| [aws_lambda_permission.scale_down](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_permission) | resource |
40+
| [aws_ssm_parameter.scale_down_config](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssm_parameter) | resource |
41+
| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |
4042
| [aws_iam_policy_document.lambda_assume_role_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
4143
| [aws_iam_policy_document.lambda_xray](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
44+
| [aws_region.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | data source |
4245

4346
## Inputs
4447

@@ -62,18 +65,18 @@ No modules.
6265
| <a name="input_log_level"></a> [log\_level](#input\_log\_level) | Log level for Lambda function | `string` | `"info"` | no |
6366
| <a name="input_logging_kms_key_id"></a> [logging\_kms\_key\_id](#input\_logging\_kms\_key\_id) | KMS key ID for CloudWatch log encryption | `string` | `null` | no |
6467
| <a name="input_logging_retention_in_days"></a> [logging\_retention\_in\_days](#input\_logging\_retention\_in\_days) | CloudWatch log retention in days | `number` | n/a | yes |
65-
| <a name="input_metrics"></a> [metrics](#input\_metrics) | Metrics configuration | <pre>object({<br/> enable = bool<br/> namespace = string<br/> metric = object({<br/> enable_github_app_rate_limit = bool<br/> })<br/> })</pre> | n/a | yes |
68+
| <a name="input_metrics"></a> [metrics](#input\_metrics) | Metrics configuration | <pre>object({<br/> enable = optional(bool, false)<br/> namespace = optional(string, "GitHub Runners")<br/> metric = optional(object({<br/> enable_github_app_rate_limit = optional(bool, true)<br/> }), {})<br/> })</pre> | `{}` | no |
6669
| <a name="input_prefix"></a> [prefix](#input\_prefix) | Prefix for Lambda function name | `string` | n/a | yes |
6770
| <a name="input_role_path"></a> [role\_path](#input\_role\_path) | IAM role path | `string` | n/a | yes |
6871
| <a name="input_role_permissions_boundary"></a> [role\_permissions\_boundary](#input\_role\_permissions\_boundary) | IAM role permissions boundary ARN | `string` | `null` | no |
6972
| <a name="input_runners_lambda_s3_key"></a> [runners\_lambda\_s3\_key](#input\_runners\_lambda\_s3\_key) | S3 key for Lambda deployment package | `string` | `null` | no |
7073
| <a name="input_runners_lambda_s3_object_version"></a> [runners\_lambda\_s3\_object\_version](#input\_runners\_lambda\_s3\_object\_version) | S3 object version for Lambda deployment package | `string` | `null` | no |
74+
| <a name="input_scale_down_parameter_store_tier"></a> [scale\_down\_parameter\_store\_tier](#input\_scale\_down\_parameter\_store\_tier) | SSM Parameter Store tier to use for persisted scale-down configuration. | `string` | `"Standard"` | no |
7175
| <a name="input_schedule_expression"></a> [schedule\_expression](#input\_schedule\_expression) | CloudWatch Event schedule expression | `string` | `"cron(*/5 * * * ? *)"` | no |
72-
| <a name="input_scale_down_parameter_store_tier"></a> [scale\_down\_parameter\_store\_tier](#input\_scale\_down\_parameter\_store\_tier) | SSM Parameter Store tier used to store scale-down configuration. | `string` | `"Standard"` | no |
76+
| <a name="input_ssm_parameter_path_prefix"></a> [ssm\_parameter\_path\_prefix](#input\_ssm\_parameter\_path\_prefix) | Base SSM parameter path prefix used to store scale-down configuration (without environment suffix). | `string` | n/a | yes |
7377
| <a name="input_tags"></a> [tags](#input\_tags) | Tags to apply to resources | `map(string)` | `{}` | no |
74-
| <a name="input_tracing_config"></a> [tracing\_config](#input\_tracing\_config) | Lambda tracing configuration | <pre>object({<br/> mode = optional(string, null)<br/> capture_http_requests = optional(string, "false")<br/> capture_error = optional(string, "false")<br/> })</pre> | n/a | yes |
78+
| <a name="input_tracing_config"></a> [tracing\_config](#input\_tracing\_config) | Lambda tracing configuration | <pre>object({<br/> mode = optional(string, null)<br/> capture_http_requests = optional(bool, false)<br/> capture_error = optional(bool, false)<br/> })</pre> | `{}` | no |
7579
| <a name="input_user_agent"></a> [user\_agent](#input\_user\_agent) | User agent string for GitHub API requests | `string` | `null` | no |
76-
| <a name="input_ssm_parameter_path_prefix"></a> [ssm\_parameter\_path\_prefix](#input\_ssm\_parameter\_path\_prefix) | Base SSM parameter path prefix used to store scale-down configuration (without environment suffix). | `string` | n/a | yes |
7780

7881
## Outputs
7982

0 commit comments

Comments
 (0)