This module is for creating a CloudWatch log group.
An example deployable log group can be found in the examples/simple directory.
The main item to consider when using this module is how long you need to retain logs for, we default to 30 days, but if you're using this module to send logs somewhere else (i.e. Elasticsearch) you should consider a much shorter retention period.
Manually, something like this:
terraform-docs md document . >> README.md
# and edit out the old stuff
The following variables are required:
Description: The environment that this log group will be in.
Type:
string
Description: The name of the log group.
Type:
string
Description: The service that this log group is associated with
Type:
string
The following variables are optional (have default values):
Description: A mapping of custom tags to add to the generated resources.
Type:
map(string)
Default:
{}
Description: How long the log group should retain logs (in days).
Type:
string
Default:
"30"
The following outputs are exported:
Description: The ARN of the log group that we created.
Description: The name of the log group we created