https://github.com/ukautz/aws-cdk-static-website

AWS CDK pattern / solution construct implementing a static website hosting with CloudFront + S3 + ACM certificate
https://github.com/ukautz/aws-cdk-static-website

aws-cdk cdk cloudfront static-site-generator static-website

Last synced: 5 days ago
JSON representation

AWS CDK pattern / solution construct implementing a static website hosting with CloudFront + S3 + ACM certificate

• Host: GitHub
• URL: https://github.com/ukautz/aws-cdk-static-website
• Owner: ukautz
• License: mit
• Created: 2021-03-03T22:58:05.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-03-24T09:15:54.000Z (over 1 year ago)
• Last Synced: 2024-12-01T14:36:57.904Z (21 days ago)
• Topics: aws-cdk, cdk, cloudfront, static-site-generator, static-website
• Language: TypeScript
• Homepage:
• Size: 347 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# AWS CDK: Static Website

An AWS CDK Level 3 construct that implements an opinionated static website in AWS using:

- A public readable S3 bucket, that mirrors the contents of local directory of `.html` files and related assets

- A CloudFront distribution, that caches the S3 delivery and enforces HTTPS

- Route53 record(s) that route one or multiple public domains to S3

- A certificate for the provided public domain(s) for HTTPS

![Diagram](static-website.png)

## Usage

Install package:

```

$ npm install @ukautz/aws-cdk-static-website

```

Then in your stack:

```typescript

import * as cdk from 'aws-cdk-lib';

import { aws_route53 as route53 } from 'aws-cdk-lib';

import { StaticWebsite } from '@ukautz/aws-cdk-static-website';

import { Construct } from 'constructs';

export class YourStack extends cdk.Stack {

  constructor(scope: Construct, id: string, props?: cdk.Stack) {

    super(scope, id, props);

    // load (or create) a hosted zone, in which the record(s) will be created

    const hostedZone = route53.HostedZone.fromLookup(this, 'HostedZone', {

      domainName: 'your-domain.tld',

    });

    // create a static website, that uploads and serves contents from a local folder

    new StaticWebsite(this, 'StaticWebsite', {

      directory: '/path/to/where/your/contents/are',

      domain: 'blog.your-domain.tld',

      hostedZone,

    });

  }

}

```

**Note**: See the [`StaticWebsiteProps` interface](docs/interfaces/staticwebsiteprops.md) for all available properties.

## See also

- [`@ukautz/aws-cdk-domain-redirector`](https://github.com/ukautz/aws-cdk-domain-redirector) - an AWS-CDK L3 construct for HTTPS domain redirection