https://github.com/terraform-trailwatch-modules/terraform-aws-efs

This Terraform module creates CloudWatch Log Metric Filters and associated Alarms for monitoring Elastic File Systems (EFS) based on specified event names.
https://github.com/terraform-trailwatch-modules/terraform-aws-efs

aws aws-efs efs terraform-module terraform-trailwatch trailwatch

Last synced: 3 days ago
JSON representation

This Terraform module creates CloudWatch Log Metric Filters and associated Alarms for monitoring Elastic File Systems (EFS) based on specified event names.

• Host: GitHub
• URL: https://github.com/terraform-trailwatch-modules/terraform-aws-efs
• Owner: terraform-trailwatch-modules
• License: mit
• Created: 2024-10-29T10:35:23.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-10-30T14:10:13.000Z (about 2 months ago)
• Last Synced: 2024-10-31T21:08:32.492Z (about 2 months ago)
• Topics: aws, aws-efs, efs, terraform-module, terraform-trailwatch, trailwatch
• Language: HCL
• Homepage: https://registry.terraform.io/modules/terraform-trailwatch-modules/efs/aws/latest
• Size: 20.5 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



Elastic File System (EFS)




  

  



## About

This Terraform module creates CloudWatch Log Metric Filters and associated Alarms for monitoring Elastic File Systems (EFS) based on specified event names. It helps ensure that critical changes to EFS are monitored effectively and alerts are sent to a pre-existing SNS topic.

## Features

- Creates CloudWatch Log Metric Filters for specified EFS instances.

- Creates CloudWatch Alarms that trigger based on metrics from the filters.

- Flexible configuration for events to monitor and alarm settings.

## Requirements

| Name | Version |

|------|---------|

|  [terraform](#requirement\_terraform) | ~> 1.0 |

|  [aws](#requirement\_aws) | ~> 5.46 |

## Inputs

| Name | Description | Type | Default | Required |

|------|-------------|------|---------|:--------:|

|  [cw\_log\_group\_name](#input\_cw\_log\_group\_name) | The name of the CloudWatch log group storing CloudTrail logs. | `string` | n/a | yes |

|  [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 |

|  [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 |

|  [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 |

|  [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 |

|  [cw\_metric\_filter\_alarm\_statistic](#input\_cw\_metric\_filter\_alarm\_statistic) | The statistic to apply to the alarm's associated metric. | `string` | `"Sum"` | no |

|  [cw\_metric\_filter\_alarm\_threshold](#input\_cw\_metric\_filter\_alarm\_threshold) | The value against which the specified statistic is compared. | `number` | `1` | no |

|  [cw\_metric\_filter\_namespace](#input\_cw\_metric\_filter\_namespace) | The namespace for the CloudWatch metric filter. | `string` | `"EFS/Monitoring"` | no |

|  [cw\_metric\_filter\_value](#input\_cw\_metric\_filter\_value) | The value to publish to the CloudWatch metric. | `string` | `"1"` | no |

|  [efs\_file\_system\_event\_names](#input\_efs\_file\_system\_event\_names) | The list of event names to monitor for each Elastic File System. | `list(string)` | 
[
  "DeleteFileSystem",
  "UpdateFileSystem",
  "CreateMountTarget",
  "DeleteMountTarget"
]
 | no |

|  [efs\_file\_system\_ids](#input\_efs\_file\_system\_ids) | The list of Elastic File System IDs to monitor. | `list(string)` | n/a | yes |


## Simple Example

```hcl

module "terraform_trailwatch_efs" {

  source                         = "terraform-trailwatch-modules/efs/aws"

  efs_file_system_ids            = ["fs-12345678", "fs-87654321"]

  cw_log_group_name              = "the-cloudtrail-log-group"

  cw_metric_filter_alarm_actions = ["arn:aws:sns:region:account-id:sns-topic"]

}

```

## Advanced Example

```hcl

module "terraform_trailwatch_efs" {

  source                                     = "terraform-trailwatch-modules/efs/aws"

  efs_file_system_ids                        = ["fs-12345678", "fs-87654321"]

  efs_file_system_event_names                = ["DeleteFileSystem", "UpdateFileSystem"]

  cw_log_group_name                          = "the-cloudtrail-log-group"

  cw_metric_filter_namespace                 = "EFS/Monitoring"

  cw_metric_filter_value                     = "1"

  cw_metric_filter_alarm_comparison_operator = "GreaterThanOrEqualToThreshold"

  cw_metric_filter_alarm_evaluation_periods  = 1

  cw_metric_filter_alarm_period              = 300

  cw_metric_filter_alarm_statistic           = "Sum"

  cw_metric_filter_alarm_threshold           = 1

  cw_metric_filter_alarm_actions             = ["arn:aws:sns:region:account-id:sns-topic"]

}

```

## Changelog

For a detailed list of changes, please refer to the [CHANGELOG.md](CHANGELOG.md).

## License

This module is licensed under the [MIT License](LICENSE).