Skip to content

Commit

Permalink
[1.0.0] Added prerelease content
Browse files Browse the repository at this point in the history
  • Loading branch information
@tionichm
tionichm committed Oct 30, 2024
1 parent b638b42 commit 5343a03
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 20 deletions.
4 changes: 1 addition & 3 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Changelog

## [1.0.0] - 2024-10-28
## [1.0.0] - 2024-10-30

### Added
- Initial release of the IAM Monitoring module.
Expand All @@ -10,7 +10,5 @@
- Alarms triggered based on defined thresholds for the specified IAM metrics.
- Detailed variable descriptions for easy customization and configuration.

## [1.0.1] - 2024-10-30

### Changed
- Updated Terraform examples in [`README.md`](README.md) to reference the module source from the Terraform Registry.
36 changes: 21 additions & 15 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<h1 align="center">Identity and Access Management (IAM)</h1>

<p align="center">
<a href="https://github.com/terraform-trailwatch-modules/terraform-trailwatch-iam/releases" title="Releases"><img src="https://img.shields.io/badge/Release-1.0.1-1d1d1d?style=for-the-badge" alt="Releases"></a>
<a href="https://github.com/terraform-trailwatch-modules/terraform-trailwatch-iam/releases" title="Releases"><img src="https://img.shields.io/badge/Release-1.0.0-1d1d1d?style=for-the-badge" alt="Releases"></a>
<a href="https://github.com/terraform-trailwatch-modules/terraform-trailwatch-iam/blob/main/LICENSE" title="License"><img src="https://img.shields.io/badge/License-MIT-1d1d1d?style=for-the-badge" alt="License"></a>
</p>

Expand All @@ -17,23 +17,29 @@ This Terraform module creates CloudWatch Log Metric Filters and associated Alarm
- Creates CloudWatch Alarms that trigger based on metrics from the filters.
- Flexible configuration for events to monitor and alarm settings.

<!-- BEGIN_TF_DOCS -->
## Requirements
- Terraform 1.0 or later
- AWS Provider

| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | ~> 1.0 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.46 |

## Inputs
| Variable | Description | Type | Default |
|----------------------------------------------|------------------------------------------------------------------------------------------------------|---------------|-----------------------------------------------------------|
| `iam_event_names` | The list of event names to monitor for Identity and Access Management. | `list(string)` | `["DeleteGroupPolicy", "DeleteRolePolicy", "DeleteUserPolicy", "PutGroupPolicy", "PutRolePolicy", "PutUserPolicy", "CreatePolicy", "DeletePolicy", "CreatePolicyVersion", "DeletePolicyVersion", "AttachRolePolicy", "DetachRolePolicy", "AttachUserPolicy", "DetachUserPolicy", "AttachGroupPolicy", "DetachGroupPolicy", "CreateUser", "DeleteUser", "UpdateUser", "CreateGroup", "DeleteGroup", "UpdateGroup", "AddUserToGroup", "RemoveUserFromGroup"]` |
| `cw_log_group_name` | The name of the CloudWatch log group storing CloudTrail logs. | `string` | n/a |
| `cw_metric_filter_namespace` | The namespace for the CloudWatch metric filter. | `string` | `IAM/Monitoring` |
| `cw_metric_filter_value` | The value to publish to the CloudWatch metric. | `string` | `1` |
| `cw_metric_filter_alarm_comparison_operator` | The comparison operator for the CloudWatch metric filter alarm. | `string` | `GreaterThanOrEqualToThreshold` |
| `cw_metric_filter_alarm_evaluation_periods` | The number of periods over which data is compared to the specified threshold. | `number` | `1` |
| `cw_metric_filter_alarm_period` | The period in seconds over which the specified statistic is applied. | `number` | `300` |
| `cw_metric_filter_alarm_statistic` | The statistic to apply to the alarm's associated metric. | `string` | `Sum` |
| `cw_metric_filter_alarm_threshold` | The value against which the specified statistic is compared. | `number` | `1` |
| `cw_metric_filter_alarm_actions` | The list of actions to execute when the alarm transitions into an ALARM state. | `list(string)` | `[]` |

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_cw_log_group_name"></a> [cw\_log\_group\_name](#input\_cw\_log\_group\_name) | The name of the CloudWatch log group storing CloudTrail logs. | `string` | n/a | yes |
| <a name="input_cw_metric_filter_alarm_actions"></a> [cw\_metric\_filter\_alarm\_actions](#input\_cw\_metric\_filter\_alarm\_actions) | The list of actions to execute when the alarm transitions into an ALARM state from any other state. | `list(string)` | `[]` | no |
| <a name="input_cw_metric_filter_alarm_comparison_operator"></a> [cw\_metric\_filter\_alarm\_comparison\_operator](#input\_cw\_metric\_filter\_alarm\_comparison\_operator) | The comparison operator for the CloudWatch metric filter alarm. | `string` | `"GreaterThanOrEqualToThreshold"` | no |
| <a name="input_cw_metric_filter_alarm_evaluation_periods"></a> [cw\_metric\_filter\_alarm\_evaluation\_periods](#input\_cw\_metric\_filter\_alarm\_evaluation\_periods) | The number of periods over which data is compared to the specified threshold. | `number` | `1` | no |
| <a name="input_cw_metric_filter_alarm_period"></a> [cw\_metric\_filter\_alarm\_period](#input\_cw\_metric\_filter\_alarm\_period) | The period in seconds over which the specified statistic is applied. | `number` | `300` | no |
| <a name="input_cw_metric_filter_alarm_statistic"></a> [cw\_metric\_filter\_alarm\_statistic](#input\_cw\_metric\_filter\_alarm\_statistic) | The statistic to apply to the alarm's associated metric. | `string` | `"Sum"` | no |
| <a name="input_cw_metric_filter_alarm_threshold"></a> [cw\_metric\_filter\_alarm\_threshold](#input\_cw\_metric\_filter\_alarm\_threshold) | The value against which the specified statistic is compared. | `number` | `1` | no |
| <a name="input_cw_metric_filter_namespace"></a> [cw\_metric\_filter\_namespace](#input\_cw\_metric\_filter\_namespace) | The namespace for the CloudWatch metric filter. | `string` | `"IAM/Monitoring"` | no |
| <a name="input_cw_metric_filter_value"></a> [cw\_metric\_filter\_value](#input\_cw\_metric\_filter\_value) | The value to publish to the CloudWatch metric. | `string` | `"1"` | no |
| <a name="input_iam_event_names"></a> [iam\_event\_names](#input\_iam\_event\_names) | The list of event names to monitor for Identity and Access Management. | `list(string)` | <pre>[<br/> "DeleteGroupPolicy",<br/> "DeleteRolePolicy",<br/> "DeleteUserPolicy",<br/> "PutGroupPolicy",<br/> "PutRolePolicy",<br/> "PutUserPolicy",<br/> "CreatePolicy",<br/> "DeletePolicy",<br/> "CreatePolicyVersion",<br/> "DeletePolicyVersion",<br/> "AttachRolePolicy",<br/> "DetachRolePolicy",<br/> "AttachUserPolicy",<br/> "DetachUserPolicy",<br/> "AttachGroupPolicy",<br/> "DetachGroupPolicy",<br/> "CreateUser",<br/> "DeleteUser",<br/> "UpdateUser",<br/> "CreateGroup",<br/> "DeleteGroup",<br/> "UpdateGroup",<br/> "AddUserToGroup",<br/> "RemoveUserFromGroup"<br/>]</pre> | no |
<!-- END_TF_DOCS -->

## Simple Example
```hcl
Expand Down
4 changes: 2 additions & 2 deletions versions.tf
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
terraform {
required_version = ">= 1.0"
required_version = "~> 1.0"

required_providers {
aws = {
source = "hashicorp/aws"
version = ">= 5.46"
version = "~> 5.46"
}
}
}

0 comments on commit 5343a03

Please sign in to comment.