https://github.com/serverless-components/aws-cloudfront

Deploy an AWS CloudFront distribution for the provided origins using Serverless Components
https://github.com/serverless-components/aws-cloudfront

aws aws-cloudfront cdn serverless serverless-components serverless-framework

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/serverless-components/aws-cloudfront
• Owner: serverless-components
• License: apache-2.0
• Created: 2019-08-20T11:04:12.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-12-08T18:08:23.000Z (almost 3 years ago)
• Last Synced: 2024-07-27T05:38:04.897Z (about 2 months ago)
• Topics: aws, aws-cloudfront, cdn, serverless, serverless-components, serverless-framework
• Language: JavaScript
• Homepage: https://serverless.com
• Size: 87.9 KB
• Stars: 27
• Watchers: 2
• Forks: 12
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# aws-cloudfront

 

Deploy an AWS CloudFront distribution for the provided origins using [Serverless Components](https://github.com/serverless/components).

 

1. [Install](#1-install)

2. [Create](#2-create)

3. [Configure](#3-configure)

4. [Deploy](#4-deploy)

 

### 1. Install

```console

$ npm install -g serverless

```

### 2. Create

```console

$ 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

```yml

# serverless.yml

distribution:

  component: '@serverless/aws-cloudfront'

  inputs:

    region: us-east-1

    enabled: true # optional

    comment: 'My distribution' # optional

    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). 

```yml

# 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

            # ...

```

#### Lambda@Edge

```yml

# 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:

```yml

# 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

### 4. Deploy

```console

$ serverless

```

 

### New to Components?

Checkout the [Serverless Components](https://github.com/serverless/components) repo for more information.