Skip to content

Set default attributes a given CloudFormation resource should have based on type

License

Notifications You must be signed in to change notification settings

neverendingqs/serverless-default-aws-resource-attributes

Repository files navigation

CircleCI Coverage Status npm version

serverless-default-aws-resource-attributes

This plugin allows you to set default attributes a given CloudFormation resource should have based on type.

This plugin affects resources generated by Serverless. For example, any default attributes defined for S3 buckets will be applied to the Serverless-generated ServerlessDeploymentBucket bucket. You are, however, able to exclude Serverless-generated resources using Exclude: (see below).

Usage

Install the plugin:

npm install -D serverless-default-aws-resource-attributes

Register the plugin in serverless.yml:

plugins:
  - serverless-default-aws-resource-attributes

Example:

custom:
  defaultAwsAttributes:
    # Enable SSE and block public access for all S3 buckets
    # Also set a DeletionPolicy for all S3 buckets
    - Type: AWS::S3::Bucket
      DeletionPolicy: Retain
      Properties:
        BucketEncryption:
          ServerSideEncryptionConfiguration:
            - ServerSideEncryptionByDefault:
                SSEAlgorithm: AES256
        PublicAccessBlockConfiguration:
          BlockPublicAcls: true
          BlockPublicPolicy: true
          IgnorePublicAcls: true
          RestrictPublicBuckets: true
    # Add logging configuration to all S3 buckets except resource with
    # logical ID 'LoggingBucket'
    - Type: AWS::S3::Bucket
      Exclude:
        - LoggingBucket
      Properties:
        LoggingConfiguration:
          DestinationBucketName:
            Ref: LoggingBucket

About

Set default attributes a given CloudFormation resource should have based on type

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Contributors 4

  •  
  •  
  •  
  •