cfn-guardian 0.7.9 → 0.7.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87b0a72c2cf978be553f83a589a2d45643358ce43434ebd4fd6d3cf8974eee27
-  data.tar.gz: c69af701ac2d137887d935c6afc6ea0503e9529c2aa685f86c0f134bc5e0905a
+  metadata.gz: 033f2fc6acd9cb43ea7d5ed3e86380ad7ca5466f933a74a9ce82d596dcd60357
+  data.tar.gz: beae571c60d4b70cfb822ecce7987ef7c4f24e95b26b998982baee926bfd9779
 SHA512:
-  metadata.gz: 11e0c2f2ef8d6b665fde021c661a4ad0c49201bc33281feab09c37ca07d9beebb64e7b2085bbd5076b89f64b2ab2e20a68f98d30c265427e25f22dfe60fc2c8e
-  data.tar.gz: fca7427abb12c5616e4162fbf0ce3a7b9e33cafc6929c301ab3084f59f642eedad0a4c68130499f3a0e5afbf3889b7af7409951b601550f2fc61deefaf633252
+  metadata.gz: 155df68c0cf8696ca55547df817e45e60e967c817b2b00eae8fb416113a776792edc9cd6ba508ef6350fca3f09da202eb384e5bfb63047b5f598b5be2098dfb7
+  data.tar.gz: b1e423475b999de9444b1a90fcf22215a65284c2694c9c68cd7d32985a0690f018fee7343e9360809be00d3ec8615bef4800540b8f01a84d59020172b48640aa

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

@@ -153,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/documentdb_cluster.rb

@@ -0,0 +1,39 @@
+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
+        @alarms.push(alarm)
+      end
+      
+    end
+  end
+  
+  

data/lib/cfnguardian/version.rb

@@ -1,4 +1,4 @@
 module CfnGuardian
-  VERSION = "0.7.9"
+  VERSION = "0.7.10"
   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.9
+  version: 0.7.10
 platform: ruby
 authors:
 - Guslington
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-13 00:00:00.000000000 Z
+date: 2022-01-28 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