CDK Construct for a private frontend hosting S3 bucket
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Project description
CDK Private S3 Hosting Construct
This is a CDK construct that creates a private S3 bucket and an Application Load Balancer (ALB) with a listener rule that forwards requests to the S3 bucket.
You can use this construct for a enterprise use case where you want to host a static website in a private network.
Original idea is from this blog post. And some implementations are referenced from this post.
Architecture
Installation
You can install the package via npm:
npm install cdk-private-s3-hosting
Usage
To create a private S3 bucket and an ALB with a listener rule that forwards requests to the S3 bucket, you can use the following code:
import { PrivateS3Hosting } from 'cdk-private-s3-hosting';
const privateS3Hosting = new PrivateS3Hosting(this, 'PrivateS3Hosting', {
domainName: 'cryer-nao-domain.com',
});
After you deploy the stack, you can access the S3 bucket using the ALB's DNS name from the VPC where the stack is deployed.
For example, if you put the hoge.txt file in the root of S3 bucket, you can access it using the following command:
curl http://cryer-nao-domain.com/hoge.txt
Use existing VPC
You can use an existing VPC by specifying the vpc property.
declare const vpc: ec2.IVpc;
const privateS3Hosting = new PrivateS3Hosting(this, 'PrivateS3Hosting', {
domainName: 'cryer-nao-domain.com',
vpc,
});
Specify the sub domain
You can specify the sub domain by setting the subDomain property.
const privateS3Hosting = new PrivateS3Hosting(this, 'PrivateS3Hosting', {
domainName: 'cryer-nao-domain.com',
subDomain: 'sub',
});
In this case, the S3 bucket name will be created with ${subDomain}.${domainName}.
If enablePrivateDns is enabled, a private hosted zone will also be created for the domainName and an A record will be created from ${subDomain}.${domainName} to the ALB DNS name.
You can retrieve hoge.txt on the root of the S3 bucket using the following command:
curl http://sub.cryer-nao-domain.com/hoge.txt
Deploy the frontend assets
You can deploy the frontend assets to the S3 bucket like below:
import { PrivateS3Hosting } from 'cdk-private-s3-hosting';
import * as s3deploy from 'aws-cdk-lib/aws-s3-deployment';
const privateS3Hosting = new PrivateS3Hosting(this, 'PrivateS3Hosting', {
domainName: 'cryer-nao-domain.com',
});
new s3deploy.BucketDeployment(this, 'DeployWebsite', {
sources: [s3deploy.Source.asset('./website-dist')],
destinationBucket: privateS3Hosting.bucket,
});
After deploying the stack, you can access the website using the domainName you specified from the VPC.
[cloudshell-user@ip-10-0-31-170 ~]$ curl http://cryer-nao-domain.com/ -L
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Vite + React + TS</title>
<script type="module" crossorigin src="/assets/index-f40OySzR.js"></script>
<link rel="stylesheet" crossorigin href="/assets/index-DiwrgTda.css">
</head>
<body>
<div id="root"></div>
</body>
</html>
Note: All access to the path pattern */ will be redirected to /index.html. Therefore, it will function correctly even when the path is set on the frontend and the page is reloaded.
Note: I also recommend to use deploy-time-build to build the frontend assets while deploying the stack.
Setup DNS
This construct creates Route53 hosted zone and an A record for the domain name you specified by default.
If you want to use your own DNS settings(e.g. using a corporate DNS server),
you can disable the Route53 hosted zone creation by setting the enablePrivateDns property to false.
import { PrivateS3Hosting } from 'cdk-private-s3-hosting';
const privateS3Hosting = new PrivateS3Hosting(this, 'PrivateS3Hosting', {
domainName: 'cryer-nao-domain.com',
enablePrivateDns: false,
});
TLS Certificate
If you want to use HTTPS, you need to create a TLS certificate in ACM and pass it to the certificate property.
import * as acm from 'aws-cdk-lib/aws-certificatemanager';
import { PrivateS3Hosting } from 'cdk-private-s3-hosting';
declare const certificate: acm.ICertificate;
const privateS3Hosting = new PrivateS3Hosting(this, 'PrivateS3Hosting', {
domainName: 'cryer-nao-domain.com',
certificate,
});
Of course, specified domain name (domainName and subDomain) must be the same as the domain name of the certificate.
Project details
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cdk_private_s3_hosting-0.0.18.tar.gz.
File metadata
- Download URL: cdk_private_s3_hosting-0.0.18.tar.gz
- Upload date:
- Size: 63.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d1319aee11b22f481d689df18003a23efdbe450a5b312dff2a22cd0a8f58589f
|
|
| MD5 |
70d0038c861bc0723afb246b15f97606
|
|
| BLAKE2b-256 |
545c46bf5fad748d0d6d0f32fe777d9742e43fb149b67f55c669f9f42f87e8e6
|
Provenance
The following attestation bundles were made for cdk_private_s3_hosting-0.0.18.tar.gz:
Publisher:
release.yml on badmintoncryer/cdk-private-s3-hosting
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cdk_private_s3_hosting-0.0.18.tar.gz -
Subject digest:
d1319aee11b22f481d689df18003a23efdbe450a5b312dff2a22cd0a8f58589f - Sigstore transparency entry: 1876795362
- Sigstore integration time:
-
Permalink:
badmintoncryer/cdk-private-s3-hosting@57b769a2ccdf4973fa4945e01cb76cfc5fe4d9a5 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/badmintoncryer
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@57b769a2ccdf4973fa4945e01cb76cfc5fe4d9a5 -
Trigger Event:
push
-
Statement type:
File details
Details for the file cdk_private_s3_hosting-0.0.18-py3-none-any.whl.
File metadata
- Download URL: cdk_private_s3_hosting-0.0.18-py3-none-any.whl
- Upload date:
- Size: 62.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
733e7fc83f10f7bdbad75166004f7862aa65388447ffc3c79194b7d246be805d
|
|
| MD5 |
97d21d0b1fca4f507975f4fe17dd1690
|
|
| BLAKE2b-256 |
4aad0f590bcfdc27112016a1eb0cbfd6d236526931391c981657d7930572c242
|
Provenance
The following attestation bundles were made for cdk_private_s3_hosting-0.0.18-py3-none-any.whl:
Publisher:
release.yml on badmintoncryer/cdk-private-s3-hosting
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cdk_private_s3_hosting-0.0.18-py3-none-any.whl -
Subject digest:
733e7fc83f10f7bdbad75166004f7862aa65388447ffc3c79194b7d246be805d - Sigstore transparency entry: 1876795227
- Sigstore integration time:
-
Permalink:
badmintoncryer/cdk-private-s3-hosting@57b769a2ccdf4973fa4945e01cb76cfc5fe4d9a5 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/badmintoncryer
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@57b769a2ccdf4973fa4945e01cb76cfc5fe4d9a5 -
Trigger Event:
push
-
Statement type:
