Create a new getStageName function

Author: rasmuseriksson90

lib/plugins/aws/package/compile/events/api-gateway/index.js

@@ -171,7 +171,6 @@ class AwsCompileApigEvents {
     this.serverless = serverless;
     this.options = options;
     this.provider = this.serverless.getProvider('aws');
-    this.provider.getStage = () => "main";
 
     this.serverless.configSchemaHandler.defineFunctionEvent('aws', 'http', {
       anyOf: [

lib/plugins/aws/package/compile/events/api-gateway/lib/api-keys.js

@@ -20,7 +20,7 @@ function createApiKeyResource(that, apiKey) {
       StageKeys: [
         {
           RestApiId: that.provider.getApiGatewayRestApiId(),
-          StageName: that.provider.getStage(),
+          StageName: that.provider.getStageName(),
         },
       ],
     },

lib/plugins/aws/package/compile/events/api-gateway/lib/deployment.js

@@ -13,7 +13,7 @@ module.exports = {
         Type: 'AWS::ApiGateway::Deployment',
         Properties: {
           RestApiId: this.provider.getApiGatewayRestApiId(),
-          StageName: this.provider.getStage(),
+          StageName: this.provider.getStageName(),
           Description: this.provider.getApiGatewayDescription(),
         },
         DependsOn: this.apiGatewayMethodLogicalIds,
@@ -34,7 +34,7 @@ module.exports = {
               { Ref: 'AWS::Region' },
               '.',
               { Ref: 'AWS::URLSuffix' },
-              `/${this.provider.getStage()}`,
+              `/${this.provider.getStageName()}`,
             ],
           ],
         },

lib/plugins/aws/package/compile/events/api-gateway/lib/request-validator.js

@@ -153,7 +153,7 @@ module.exports = {
     const validatorLogicalId = this.provider.naming.getValidatorLogicalId();
     const validatorName = `${
       this.serverless.service.service
-    }-${this.provider.getStage()} | Validate request body and querystring parameters`;
+    }-${this.provider.getStageName()} | Validate request body and querystring parameters`;
     this.serverless.service.provider.compiledCloudFormationTemplate.Resources[validatorLogicalId] =
       {
         Type: 'AWS::ApiGateway::RequestValidator',

lib/plugins/aws/package/compile/events/api-gateway/lib/usage-plan.js

@@ -10,13 +10,13 @@ function createUsagePlanResource(that, name) {
       ApiStages: [
         {
           ApiId: that.provider.getApiGatewayRestApiId(),
-          Stage: that.provider.getStage(),
+          Stage: that.provider.getStageName(),
         },
       ],
       Description: `Usage plan "${name}" for ${
         that.serverless.service.service
-      } ${that.provider.getStage()} stage`,
-      UsagePlanName: `${that.serverless.service.service}-${name}-${that.provider.getStage()}`,
+      } ${that.provider.getStageName()} stage`,
+      UsagePlanName: `${that.serverless.service.service}-${name}-${that.provider.getStageName()}`,
     },
   };
   const template = _.cloneDeep(resourceTemplate);
@@ -26,10 +26,10 @@ function createUsagePlanResource(that, name) {
     // create old legacy resources
     template.Properties.UsagePlanName = `${
       that.serverless.service.service
-    }-${that.provider.getStage()}`;
+    }-${that.provider.getStageName()}`;
     template.Properties.Description = `Usage plan for ${
       that.serverless.service.service
-    } ${that.provider.getStage()} stage`;
+    } ${that.provider.getStageName()} stage`;
     // assign quota
     if (_.get(usagePlan, 'quota')) {
       _.merge(template, {

lib/plugins/aws/package/compile/events/api-gateway/lib/validate.js

@@ -184,7 +184,7 @@ module.exports = {
           }
 
           const provider = this.serverless.getProvider('aws');
-          const stage = provider.getStage();
+          const stage = provider.getStageName();
           const validAPIGatewayStageNamePattern = /^[-_a-zA-Z0-9]+$/;
           if (!validAPIGatewayStageNamePattern.test(stage)) {
             throw new ServerlessError(

lib/plugins/aws/provider.js

@@ -806,6 +806,7 @@ class AwsProvider {
                   },
                   additionalProperties: false,
                 },
+                stageName: { type: 'string' },
                 shouldStartNameWithService: { type: 'boolean' },
                 usagePlan: {
                   anyOf: [
@@ -1882,6 +1883,17 @@ class AwsProvider {
     return stageSourceValue.value || defaultStage;
   }
 
+  getStageName() {
+    if (
+      this.serverless.service.provider.apiGateway &&
+      this.serverless.service.provider.apiGateway.stageName
+    ) {
+      return this.serverless.service.provider.apiGateway.stageName;
+    }
+
+    return this.getStage();
+  }
+
   /**
    * Get API Gateway Rest API ID from serverless config
    */