Allow provider tags on AWS::ApiGateway::RestApi

Author: tazorax

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

@@ -47,15 +47,31 @@ module.exports = {
     const DisableExecuteApiEndpoint =
       apiGateway.disableDefaultEndpoint == null ? undefined : apiGateway.disableDefaultEndpoint;
 
+    const properties = {
+      Name: this.provider.naming.getApiGatewayName(),
+      BinaryMediaTypes,
+      DisableExecuteApiEndpoint,
+      EndpointConfiguration,
+    };
+
+    // Tags
+    if (
+      this.serverless.service.provider.tags &&
+      this.serverless.service.provider.restApi &&
+      this.serverless.service.provider.restApi.useProviderTags
+    ) {
+      properties.Tags = Object.entries(this.serverless.service.provider.tags).map(
+        ([Key, Value]) => ({
+          Key,
+          Value,
+        })
+      );
+    }
+
     _.merge(this.serverless.service.provider.compiledCloudFormationTemplate.Resources, {
       [this.apiGatewayRestApiLogicalId]: {
         Type: 'AWS::ApiGateway::RestApi',
-        Properties: {
-          Name: this.provider.naming.getApiGatewayName(),
-          BinaryMediaTypes,
-          DisableExecuteApiEndpoint,
-          EndpointConfiguration,
-        },
+        Properties: properties,
       },
     });
 

lib/plugins/aws/provider.js

@@ -1289,6 +1289,13 @@ class AwsProvider {
                 'sa-east-1',
               ],
             },
+            restApi: {
+              type: 'object',
+              properties: {
+                useProviderTags: { type: 'boolean' },
+              },
+              additionalProperties: false,
+            },
             role: { $ref: '#/definitions/awsLambdaRole' },
             rolePermissionsBoundary: { $ref: '#/definitions/awsArnString' },
             rollbackConfiguration: {

types/index.d.ts

@@ -1058,6 +1058,9 @@ export interface AWS {
     | "me-central-1"
     | "me-south-1"
     | "sa-east-1";
+    restApi?: {
+      useProviderTags?: boolean;
+    };
     role?: AwsLambdaRole;
     rolePermissionsBoundary?: AwsArnString;
     rollbackConfiguration?: {