Skip to content

Commit

Permalink
docs: terraform docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Downager committed Nov 6, 2023
1 parent 0d848eb commit 0c2eafb
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions docs/variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,16 @@ This document gives an overview of variables used in the aws asg lifecycle modul

| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13.1 |
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.5.0 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.0 |
| <a name="requirement_null"></a> [null](#requirement\_null) | ~> 3.0 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
| <a name="provider_null"></a> [null](#provider\_null) | n/a |
| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.24.0 |
| <a name="provider_null"></a> [null](#provider\_null) | 3.2.1 |

## Modules

Expand All @@ -34,14 +36,13 @@ This document gives an overview of variables used in the aws asg lifecycle modul
| [null_resource.assign_default_sg](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource |
| [aws_iam_policy_document.lifecycle](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
| [aws_iam_policy_document.lifecycle_profile](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
| [aws_region.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | data source |

## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_autoscaling_group_name"></a> [autoscaling\_group\_name](#input\_autoscaling\_group\_name) | The name of the Auto Scaling group to which you want to assign the lifecycle hook | `string` | n/a | yes |
| <a name="input_cloudwatch_log_group_kms_key_id"></a> [cloudwatch\_log\_group\_kms\_key\_id](#input\_cloudwatch\_log\_group\_kms\_key\_id) | The ARN of the KMS Key to use when encrypting log data for Lambda | `string` | `null` | no |
| <a name="input_cloudwatch_log_group_retention_in_days"></a> [cloudwatch\_log\_group\_retention\_in\_days](#input\_cloudwatch\_log\_group\_retention\_in\_days) | Specifies the number of days you want to retain log events in log group for Lambda. | `number` | `90` | no |
| <a name="input_default_result"></a> [default\_result](#input\_default\_result) | (optional) describe your variable | <pre>object({<br> launching = string<br> terminating = string<br> })</pre> | n/a | yes |
| <a name="input_extra_tags"></a> [extra\_tags](#input\_extra\_tags) | The extra tag for resource | `map(string)` | n/a | yes |
| <a name="input_heartbeat_timeout"></a> [heartbeat\_timeout](#input\_heartbeat\_timeout) | lifecycle hook timeout in second | <pre>object({<br> launching = number<br> terminating = number<br> })</pre> | n/a | yes |
Expand Down

0 comments on commit 0c2eafb

Please sign in to comment.