aws-cloudfront

This package was copied from https://github.com/serverless-components/aws-cloudfront because it wasn't being maintained anymore. It is being used by the nextjs serverless component to provision the CloudFront distribution behind the scenes.

Deploy an AWS CloudFront distribution for the provided origins using Serverless Components.

1. Install
2. Create
3. Configure
4. Deploy

1. Install

$ npm install -g serverless

2. Create

$ mkdir cdn
$ cd cdn

the directory should look something like this:

|- serverless.yml
|- .env      # your AWS api keys

# .env
AWS_ACCESS_KEY_ID=XXX
AWS_SECRET_ACCESS_KEY=XXX

3. Configure

# serverless.yml

distribution:
  component: '@serverless/aws-cloudfront'
  inputs:
    distributionId: XYZEXAMPLE #optional
    region: us-east-1
    enabled: true # optional
    comment: 'My distribution' # optional
    aliases: ['foo.example.com', 'bar.example.com']
    priceClass: 'PriceClass_All' # optional
    errorPages: # optional
      - code: 503
        path: "/503.html"
        minTTL: 5 # optional, minimum ttl the error is cached (default 10)
        responseCode: 500 # optional, alters the response code
    defaults: # optional
      ttl: 15
      allowedHttpMethods: ['HEAD', 'GET']
      forward: # optional
        # array of header names, 'none' or 'all'
        headers: ['Accept', 'Accept-Language']
        # array of cookie names, 'none' or 'all'
        cookies: ['my-cookie]
        queryString: true
        queryStringCacheKeys: ['queryKey']
      viewerProtocolPolicy: 'https-only' # optional
      smoothStreaming: true # optional
      compress: true # optional
      fieldLevelEncryptionId: '123' # optional
      lambda@edge: # added to cloudfront default cache behavior
        viewer-request: arn:aws:lambda:us-east-1:123:function:myFunc:version
    origins:
      - https://my-bucket.s3.amazonaws.com

Custom cache behavior

Custom cache behaviors support the same config parameters as the default cache behavior (see the example above).

# serverless.yml

distribution:
  component: "@serverless/aws-cloudfront"
  inputs:
    origins:
      - url: https://my-assets.com
        pathPatterns:
          /static/images: # route any /static/images requests to https://my-assets.com
            ttl: 10
            allowedHttpMethods: ["GET", "HEAD"] # optional
            forward: # optional
              headers: "all"
              cookies: ["auth-token"]
              queryString: true
            compress: false # optional
            # ...

Custom origin config

To configure custom origins: https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_CustomOriginConfig.html

# serverless.yml

distribution:
  component: "@serverless/aws-cloudfront"
  inputs:
    origins:
      - url: http://old-api.com
        protocolPolicy: http-only
        pathPatterns:
          /old-api:
          # ...

Lambda@Edge

# serverless.yml

distribution:
  component: "@serverless/aws-cloudfront"
  inputs:
    origins:
      - url: https://sampleorigin.com
        pathPatterns:
          /sample/path:
            ttl: 10
            lambda@edge:
              viewer-request: arn:aws:lambda:us-east-1:123:function:myFunc:version # lambda ARN including version

Private S3 Content

To restrict access to content that you serve from S3 you can mark as private your S3 origins:

# serverless.yml

distribution:
  component: "@serverless/aws-cloudfront"
  inputs:
    origins:
      - url: https://my-private-bucket.s3.amazonaws.com
        private: true

A bucket policy will be added that grants CloudFront with access to the bucket objects. Note that it doesn't remove any existing permissions on the bucket. If users currently have permission to access the files in your bucket using Amazon S3 URLs you will need to manually remove those.

This is documented in more detail here: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html

Updating an existing CloudFront distribution

To update an existing CloudFront distribution you can add the optional distributionId to your config:

distribution:
  component: "@serverless/aws-cloudfront"
  inputs:
    distributionId: SomeDistributionId

To update an existing origin with a new cache behavior the component uses the origin's url value to find and update with the specified config:

distribution:
  component: "@serverless/aws-cloudfront"
  inputs:
    distributionId: SomeDistributionId
    origins:
      - url: https://some-existing-origin.com
        pathPatterns:
          /some/new/path:
            ttl: 10

To add a new origin to the existing CloudFront distribution just specify the new origin as you would normally:

distribution:
  component: "@serverless/aws-cloudfront"
  inputs:
    distributionId: SomeDistributionId
    origins:
      - url: https://some-new-origin.com

This will create the new origin and add any defined cache behaviors to that origin.

4. Deploy

$ serverless

Credits

This package was originally implemented by the serverless framework team. I decided to fork it and bring it into this monorepo because it wasn't being maintained anymore