add the option to disable the plugin

Author: Imran

README.md

@@ -7,7 +7,7 @@ DynamoDB currently imposes some strict limitations when [creating global tables]
 - The table names must match
 - Streams must be enabled
 - All tables must be empty
-- If a replica table is removed from a global table it can not be readded. You can however drop the table and recreate it to add it to global replication.
+- If a replica table is removed from a global table it can not be added again. You can however drop the table and recreate it to add it to global replication.
 
 The plugin handles these limitation by enabling global replication for all tables defined in the serverless stack and thus tying the global tables lifecycle to the table resources defined in the stack. Adding and removing tables from the stack will add and remove them from replication.
 
@@ -33,4 +33,16 @@ serverless deploy --region us-east-1
 serverless deploy --region eu-west-1
 ```
 
-When you add/remove table resources from your serverless stack they will also be added/removed from global replication but you will need to redeploy your stack to each region.
+When you add/remove table resources from your serverless stack they will also be added/removed from global replication but you will need to redeploy your stack to each region.
+
+## Disabling
+
+The plugin is enabled by default. You can disable the plugin via config. You may want to do this in certain environments for example.
+
+```yml
+custom:
+  createDynamoDBGlobalTables:
+    enabled: ${self:custom.variables.${self:custom.variables.stage}.enabled}
+```
+
+Disabling the plugin after deploying the stack will have no effect on global tables that were previously deployed. This is due to the previously mentioned limitations of dyanmodb global tables.

package-lock.json

@@ -23,6 +23,7 @@
   "dependencies": {
     "aws-sdk": "^2.382.0",
     "chalk": "^2.4.1",
+    "lodash.get": "^4.4.2",
     "lodash.values": "^4.3.0"
   },
   "devDependencies": {

package.json

@@ -1,17 +1,24 @@
 const AWS = require('aws-sdk');
 const _values = require('lodash.values');
+const _get = require('lodash.get');
 const chalk = require('chalk');
 
 class CreateDynamoDBGlobalTables {
   constructor(serverless, options) {
     this.serverless = serverless;
     this.options = options;
+    this.enabled = _get(serverless, 'service.custom.dynamoDBGlobalTables.enabled', true);
     this.hooks = {
       'after:deploy:deploy': this.createGlobalTables.bind(this),
     };
   }
 
   async createGlobalTables() {
+    if(this.enabled == false) {
+      this.log('Plugin disabled');
+      return;
+    }
+
     const provider = this.serverless.getProvider('aws');
     const region = provider.getRegion();
     const tableNames = this.getTableNames();

src/index.js

@@ -159,6 +159,28 @@ describe('Creating a global dynamodb tables', () => {
       plugin.createGlobalTables().should.be.rejected;
     });
   });
+
+  describe('when the plugin is disabled', () => {
+
+    before(async () => {
+      given_aws_dynamodb_is_mocked();
+      serverless = given_the_plugin_is_disabled();
+      plugin = new CreateDynamoDBGlobalTables(serverless);
+      await plugin.createGlobalTables();
+    });
+
+    after(() => {
+      AWSMock.restore();
+    });
+
+    it('does not create any global tables', () => {
+      createGlobalTables.should.not.have.been.called;
+    });
+
+    it('does not add any replicas', () => {
+      addReplicas.should.not.have.been.called;
+    });
+  });
 });
 
 const given_aws_dynamodb_is_mocked = () => {
@@ -201,4 +223,16 @@ const given_a_serverless_stack_with_some_tables = () => ({
       }
     }
   }
+});
+
+const given_the_plugin_is_disabled = () => ({
+  getProvider: () => ({ getRegion: () => 'eu-west-2' }),
+  cli: { consoleLog: () => { } },
+  service: {
+    custom: {
+      dynamoDBGlobalTables : {
+        enabled: false
+      }
+    }
+  }
 });