cfn-guardian 0.7.8 → 0.7.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a35aa6434b3e71e37d08529898d632fdcea4a1e20bd396de9c04be85286009b
-  data.tar.gz: 11aad02e101ec458448660bca9a694fb6cd2ebb0328fe28b926af0f518f73fae
+  metadata.gz: 417f7145c2f3ed6aad68367aed3a0390079df27be61d8cf8ac32909d349b3483
+  data.tar.gz: c5626e55e419a321a3be745dabb9cedb268a6552bedbf45834ebe448c42ecaf4
 SHA512:
-  metadata.gz: 1cb55d61b0ef40f720e6eaf0097e2a0b7f4282f3567502d531c84bdc2c48c37f8ab10907911fef2623d873a62ce093e202c6548cb7977dfb96c3ae01343b0701
-  data.tar.gz: c6211a8d71b647ba6fab0710a35a7b4a6d47e29e9cc1ade6637bd6c218592cdaf0adb42304f8966c3192cd1f173c899a9b5a620be2568d8365d5b4ff38308464
+  metadata.gz: 19940d4b1a253b4fd2a87994a6232ecc0e93108fb565fe1d6ad20b9f813ad7a8a05ce2c67a3307bddcbb28142f48907f246a8da1328facf8be5567c0e4a7856b
+  data.tar.gz: 99c1c4aae4a204495e47010a81e091a3ebf20a33df5746a69ba964bb23af90cfdaba322d1f948a3978893b86e419269e1f9a6da793816d1fb05b48324361b3df

data/README.md

@@ -29,6 +29,7 @@ CfnGuardian is a AWS monitoring tool with a few capabilities:
 - Network TargetGroups
 - AutoScalingGroups
 - CloudFront Distributions
+- DocumentDB Clusters
 - DynamoDB Tables
 - EC2 Instances
 - ECS Clusters

data/docs/event_subscriptions.md

@@ -10,14 +10,14 @@ As with the default alarms in Guardian, there are default events for some resour
 
 ## Overriding Defaults
 
-Default properites of the events can be overridden through the config YAML using the `EventsSubscription` top level key.
+Default properties of the events can be overridden through the config YAML using the `EventsSubscriptions` top level key.
 For example here we are changing the topic the event is being send to.
 
 ```yaml
 Topics:
     CustomEvents: arn:aws:sns....
 
-EventSubscription:
+EventSubscriptions:
   Ec2Instance:
     InstanceTerminated:
       Topic: CustomEvents
@@ -28,12 +28,24 @@ EventSubscription:
 Default events can be disabled, the same way default alarms can be disabled through the config YAML.
 
 ```yaml
-EventSubscription:
+EventSubscriptions:
   Ec2Instance:
     # set the instance terminated event to false to disable the event
     InstanceTerminated: false
 ```
 
+## Enabling Default Events
+
+Some templates may have events that are disabled by default, they can be enabled using a slightly different syntax to disabling.
+
+```yaml
+EventSubscriptions:
+  RDSInstance:
+    # set the replication failure event to true to enable the event
+    ReplicationFailure: 
+      Enabled: true
+```
+
 ## Creating Custom Events
 
 Custom events can be created if there are not defaults for that event. They can be inherited from a default event or from the base event model.
@@ -44,7 +56,7 @@ This is useful if you want to create a new event and a default event already has
 The following example inherits the `MasterPasswordReset` RDS event and creates a new event that captures the security group add to an rds instance event.
 
 ```yaml
-EventSubscription:
+EventSubscriptions:
   RDSInstance:
     # Create a new event name
     DBNewSecurityGroup:
@@ -59,7 +71,7 @@ EventSubscription:
 If there are no default events that match the format you require you can create an event of the base event subscription model.
 
 ```yaml
-EventSubscription:
+EventSubscriptions:
   ECSCluster:
     ContainerInstanceStateChange:
       Source: aws.ecs

data/docs/resources.md

@@ -39,6 +39,7 @@ Resources:
 | ApiGateway                  | Id               |
 | AmazonMQBroker              | Id               |
 | AutoScalingGroup            | Id               |
+| DocumentDBCluster           | Id               |
 | DynamoDBTable               | Id               |
 | ElastiCacheReplicationGroup | Id               |
 | ElasticFileSystem           | Id               |

data/lib/cfnguardian/compile.rb

@@ -12,6 +12,7 @@ require 'cfnguardian/resources/autoscaling_group'
 require 'cfnguardian/resources/cloudfront_distribution'
 require 'cfnguardian/resources/autoscaling_group'
 require 'cfnguardian/resources/domain_expiry'
+require 'cfnguardian/resources/documentdb_cluster'
 require 'cfnguardian/resources/dynamodb_table'
 require 'cfnguardian/resources/ec2_instance'
 require 'cfnguardian/resources/ecs_cluster'

data/lib/cfnguardian/config/defaults.yaml

@@ -19,6 +19,8 @@ Resources:
   - Id: Default
   CloudFrontDistribution:
   - Id: Default
+  DocumentDBCluster:
+  - Id: Default
   DomainExpiry:
   - Id: Default
   DynamoDBTable:

data/lib/cfnguardian/models/alarm.rb

@@ -141,6 +141,7 @@ module CfnGuardian
         }
         @statistic = 'Average'
         @evaluation_periods = 5
+        @treat_missing_data = 'notBreaching'
       end
     end
     
@@ -152,6 +153,15 @@ module CfnGuardian
         @dimensions = { AutoScalingGroupName: resource['Id'] }
       end
     end
+
+    class DocumentDBClusterAlarm < BaseAlarm
+      def initialize(resource)
+        super(resource)
+        @group = 'DocumentDBCluster'
+        @namespace = 'AWS/DocDB'
+        @dimensions = { DBClusterIdentifier: resource['Id'] }
+      end
+    end
     
     class DomainExpiryAlarm < BaseAlarm
       def initialize(resource)

data/lib/cfnguardian/resources/amazonmq_broker.rb

@@ -8,7 +8,9 @@ module CfnGuardian::Resource
       alarm.comparison_operator = 'LessThanThreshold'
       alarm.statistic = 'Minimum'
       alarm.threshold = 15
-      alarm.evaluation_periods = 1
+      alarm.period = 300
+      alarm.datapoints_to_alarm = 2
+      alarm.evaluation_periods = 2
       alarm.treat_missing_data = 'notBreaching'
       @alarms.push(alarm)
       
@@ -18,7 +20,9 @@ module CfnGuardian::Resource
       alarm.comparison_operator = 'LessThanThreshold'
       alarm.statistic = 'Minimum'
       alarm.threshold = 30
-      alarm.evaluation_periods = 1
+      alarm.period = 300
+      alarm.datapoints_to_alarm = 2
+      alarm.evaluation_periods = 2
       alarm.treat_missing_data = 'notBreaching'
       alarm.alarm_action = 'Warning'
       @alarms.push(alarm)

data/lib/cfnguardian/resources/documentdb_cluster.rb

@@ -0,0 +1,40 @@
+module CfnGuardian::Resource
+    class DocumentDBCluster < Base
+      
+      def default_alarms    
+        alarm = CfnGuardian::Models::DocumentDBClusterAlarm.new(@resource)
+        alarm.name = 'CPUUtilizationHighBase'
+        alarm.metric_name = 'CPUUtilization'
+        alarm.threshold = 75
+        alarm.evaluation_periods = 60
+        alarm.alarm_action = 'Warning'
+        @alarms.push(alarm)
+
+        alarm = CfnGuardian::Models::DocumentDBClusterAlarm.new(@resource)
+        alarm.name = 'CPUUtilizationHighSpike'
+        alarm.metric_name = 'CPUUtilization'
+        alarm.threshold = 95
+        alarm.evaluation_periods = 10
+        @alarms.push(alarm)
+
+        alarm = CfnGuardian::Models::DocumentDBClusterAlarm.new(@resource)
+        alarm.name = 'DatabaseConnections'
+        alarm.metric_name = 'DatabaseConnections'
+        alarm.statistic = 'Minimum'
+        alarm.threshold = 50
+        alarm.evaluation_periods = 10
+        @alarms.push(alarm)
+
+        alarm = CfnGuardian::Models::DocumentDBClusterAlarm.new(@resource)
+        alarm.name = 'FreeableMemory'
+        alarm.metric_name = 'FreeableMemory'
+        alarm.threshold = 1000000000
+        alarm.evaluation_periods = 3
+        alarm.comparison_operator = 'LessThanThreshold'
+        @alarms.push(alarm)
+      end
+      
+    end
+  end
+  
+  

data/lib/cfnguardian/resources/ec2_instance.rb

@@ -14,8 +14,9 @@ module CfnGuardian
         alarm = CfnGuardian::Models::Ec2InstanceAlarm.new(@resource)
         alarm.name = 'StatusCheckFailed'
         alarm.metric_name = 'StatusCheckFailed'
-        alarm.threshold = 90
-        alarm.evaluation_periods = 10
+        alarm.threshold = 0
+        alarm.evaluation_periods = 1
+        alarm.comparison_operator = 'GreaterThanThreshold'
         @alarms.push(alarm)
 
         alarm = CfnGuardian::Models::Ec2InstanceAlarm.new(@resource)

data/lib/cfnguardian/resources/http.rb

@@ -36,6 +36,7 @@ module CfnGuardian::Resource
         alarm.name = 'ExpiresInDaysCritical'
         alarm.metric_name = 'ExpiresInDays'
         alarm.threshold = 5
+        alarm.treat_missing_data = 'notBreaching'
         @alarms.push(alarm)
         
         alarm = CfnGuardian::Models::SslAlarm.new(@resource)
@@ -43,6 +44,7 @@ module CfnGuardian::Resource
         alarm.metric_name = 'ExpiresInDays'
         alarm.alarm_action = 'Task'
         alarm.threshold = 30
+        alarm.treat_missing_data = 'notBreaching'
         @alarms.push(alarm)
       end
     end

data/lib/cfnguardian/version.rb

@@ -1,4 +1,4 @@
 module CfnGuardian
-  VERSION = "0.7.8"
+  VERSION = "0.7.12"
   CHANGE_SET_VERSION = VERSION.gsub('.', '-').freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfn-guardian
 version: !ruby/object:Gem::Version
-  version: 0.7.8
+  version: 0.7.12
 platform: ruby
 authors:
 - Guslington
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-19 00:00:00.000000000 Z
+date: 2022-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -280,6 +280,7 @@ files:
 - lib/cfnguardian/resources/base.rb
 - lib/cfnguardian/resources/batch.rb
 - lib/cfnguardian/resources/cloudfront_distribution.rb
+- lib/cfnguardian/resources/documentdb_cluster.rb
 - lib/cfnguardian/resources/domain_expiry.rb
 - lib/cfnguardian/resources/dynamodb_table.rb
 - lib/cfnguardian/resources/ec2_instance.rb