Skip to main content

Module: efs-cloudwatch-sns-alarms

Create a set of sane EFS CloudWatch alerts for monitoring the health of an EFS resource.

areametriccomparison operatorthresholdrationale
StorageBurstCreditBalance<192000000000192 GB in Bytes (last hour where you can burst at 100 MB/sec)
StoragePercentIOLimit>95When the IO limit has been exceeded, the system performance drops.

Examples

resource "aws_efs_file_system" "default" {
creation_token = "app"
}

module "efs_alarms" {
source = "git::https://github.com/cloudposse/terraform-aws-efs-cloudwatch-sns-alarms.git?ref=master"
filesystem_id = "${aws_efs_file_system.default.id}"
}

Requirements

No requirements.

Providers

NameVersion
awsn/a

Modules

No modules.

Resources

NameType
aws_cloudwatch_metric_alarm.burst_credit_balance_too_lowresource
aws_cloudwatch_metric_alarm.percent_io_limit_too_highresource
aws_sns_topic.defaultresource
aws_sns_topic_policy.defaultresource
aws_caller_identity.defaultdata source
aws_iam_policy_document.sns_topic_policydata source

Inputs

NameDescriptionTypeDefaultRequired
add_sns_policyAttach a policy that allows the notifications through to the SNS topic endpointstring"false"no
additional_endpoint_arnsAny alert endpoints, such as autoscaling, or app escaling endpoint arns that will respond to an alertlist(string)[]no
burst_credit_balance_thresholdThe minimum number of burst credits that a file system should have.string"192000000000"no
filesystem_idThe EFS file system ID that you want to monitorstringn/ayes
percent_io_limit_thresholdIO Limit thresholdstring"95"no
sns_topic_arnAn SNS topic ARN that has already been created. Its policy must already allow access from CloudWatch Alarms, or set add_sns_policy to truestring""no

Outputs

NameDescription
sns_topic_arnAn SNS topic ARN that has already been created. Its policy must already allow access from CloudWatch Alarms, or set add_sns_policy to true