https://github.com/cn-terraform/terraform-aws-cloudwatch-logs
AWS CloudWatch Logs Terraform Module
https://github.com/cn-terraform/terraform-aws-cloudwatch-logs
Last synced: 15 days ago
JSON representation
AWS CloudWatch Logs Terraform Module
- Host: GitHub
- URL: https://github.com/cn-terraform/terraform-aws-cloudwatch-logs
- Owner: cn-terraform
- License: apache-2.0
- Created: 2019-07-11T13:28:34.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-02-20T14:01:04.000Z (over 1 year ago)
- Last Synced: 2025-02-15T08:30:53.441Z (4 months ago)
- Language: HCL
- Homepage: https://registry.terraform.io/modules/cn-terraform/cloudwatch-logs
- Size: 84 KB
- Stars: 5
- Watchers: 3
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# AWS CloudWatch Logs Terraform Module #
This Terraform module deploys an AWS CloudWatch Log Stream and Group.
[](https://github.com/cn-terraform/terraform-aws-cloudwatch-logs/actions?query=workflow%3Aterraform)
[](https://github.com/cn-terraform/terraform-aws-cloudwatch-logs)
[](https://github.com/cn-terraform/terraform-aws-cloudwatch-logs)
[](https://github.com/cn-terraform/terraform-aws-cloudwatch-logs)
[](https://github.com/cn-terraform/terraform-aws-cloudwatch-logs)
[](https://github.com/cn-terraform/terraform-aws-cloudwatch-logs)
## Usage
Check valid versions on:
* Github Releases:
* Terraform Module Registry:
## Install pre commit hooks.
Pleas run this command right after cloning the repository.
pre-commit install
For that you may need to install the folowwing tools:
* [Pre-commit](https://pre-commit.com/)
* [Terraform Docs](https://terraform-docs.io/)
* [tfsec](https://tfsec.dev/)
In order to run all checks at any point run the following command:
pre-commit run --all-files
## Requirements
| Name | Version |
|------|---------|
| [terraform](#requirement\_terraform) | >= 0.13 |
| [aws](#requirement\_aws) | >= 4 |
## Providers
| Name | Version |
|------|---------|
| [aws](#provider\_aws) | 4.0.0 |
## Modules
No modules.
## Resources
| Name | Type |
|------|------|
| [aws_cloudwatch_log_group.log_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | resource |
| [aws_cloudwatch_log_stream.log_stream](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_stream) | resource |
| [aws_kms_key.encryption_key](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/kms_key) | resource |
| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | 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 |
|------|-------------|------|---------|:--------:|
| [create\_kms\_key](#input\_create\_kms\_key) | If true a new KMS key will be created to encrypt the logs. If set to false a custom key can be used by setting the variable `log_group_kms_key_id` | `bool` | `false` | no |
| [log\_group\_kms\_key\_id](#input\_log\_group\_kms\_key\_id) | The ARN of the KMS Key to use when encrypting log data. Please note, after the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and AWS CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested. | `string` | `null` | no |
| [log\_group\_retention\_in\_days](#input\_log\_group\_retention\_in\_days) | (Optional) Specifies the number of days you want to retain log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653, and 0. If you select 0, the events in the log group are always retained and never expire. Default to 30 days. | `number` | `30` | no |
| [logs\_path](#input\_logs\_path) | Path of the logs in CloudWatch | `any` | n/a | yes |
| [tags](#input\_tags) | Resource tags | `map(string)` | `{}` | no |
## Outputs
| Name | Description |
|------|-------------|
| [encryption\_key\_arn](#output\_encryption\_key\_arn) | The Amazon Resource Name (ARN) of the key. |
| [encryption\_key\_id](#output\_encryption\_key\_id) | The globally unique identifier for the key. |
| [log\_group\_arn](#output\_log\_group\_arn) | The Amazon Resource Name (ARN) specifying the log group. |
| [log\_group\_name](#output\_log\_group\_name) | The name of the log group. |
| [log\_group\_retention\_in\_days](#output\_log\_group\_retention\_in\_days) | Specifies the number of days log events are retained |
| [log\_stream\_arn](#output\_log\_stream\_arn) | The Amazon Resource Name (ARN) specifying the log stream. |
| [log\_stream\_log\_group\_name](#output\_log\_stream\_log\_group\_name) | The name of the log group under which the log stream was created |
| [log\_stream\_name](#output\_log\_stream\_name) | The name of the log stream. |
| [logs\_path](#output\_logs\_path) | Path of the logs in CloudWatch |