serverless-resource-tagging-plugin v1.2.0

serverless-resource-tagging-plugin

Serverless stackTags apply once to AWS resources at first-time deploy. This plugin applies them on every deploy so that updates are applied to existing deploys.

NOTES:

• For AWS Provider Only
• Applies both provider.stackTags and provider.tags to supported resources
• Skips resources that have deploy-time CloudFormation conditional on the root Properties value, such as

  Properties: 
    Fn::If:
      - IsOtherRegionDeployed
      - ${file(additional.yml):BucketProps.withReplication}
      - ${file(additional.yml):BucketProps.noReplication}

Install plugin

npm install -D serverless-resource-tagging-plugin

serverless.yml

provider:
  name: aws
  stackTags:
    MyOrg:stackTag: provider.stackTags
    MyOrg:Name: ${self:service}
    MyOrg:Region: ${opt:region}
    MyOrg:Environment: ${opt:stage}

plugins:
  - serverless-resource-tagging-plugin

Supported AWS Resources

A tiny subset of supported resources:

AWS::ApiGateway::DomainName
AWS::ApiGateway::RestApi
AWS::ApiGateway::Stage
AWS::CloudFront::Distribution
AWS::Cognito::UserPool
AWS::DynamoDB::Table
AWS::IAM::Role
AWS::Kinesis::Stream
AWS::Lambda::Function
AWS::Logs::LogGroup
AWS::S3::Bucket
AWS::SNS::Topic
AWS::SQS::Queue
AWS::StepFunctions::StateMachine

For the many other supported formats, see the source here

Additional Config

Optionally, you can add other AWS resource types for tagging with

custom:
  resourceTagging:
    types:
      - AWS::Custom::Resource

If you only want specific resources you define, add the exclusive flag

custom:
  resourceTagging:
    exclusive: true
    types:
      - AWS::Custom::Resource

If you want to exclude certain resources by type or logical ID

custom:
  resourceTagging:
    excludes:
      - AWS::SNS::Topic
      - AWS::SQS::Queue
      - ServerlessDeploymentBucket

To adjust the log level (default: info)

custom:
  resourceTagging:
    log: debug # one of [error, warn, info, debug]