Skip to main content

@aws-prototyping-sdk/static-website

Project description

The static-website module is able to deploy your pre-packaged static website content into an S3 Bucket, fronted by Cloudfront. This module uses an Origin Access Identity to ensure your Bucket can only be accessed via Cloudfront and is configured to only allow HTTPS requests by default. Custom runtime configurations can also be specified which will emit a runtime-config.json file along with your website content. Typically this includes resource Arns, Id's etc which may need to be referenced from your website. This package uses sane defaults and at a minimum only requires the path to your website assets.

Below is a conceptual view of the default architecture this module creates:

Cloudfront Distribution (HTTPS only) -> S3 Bucket (Private via OAI)
|_ WAF V2 ACL                                |_ index.html (+ other website files and assets)
                                             |_ runtime-config.json

A typical use case is to create a static website with AuthN. To accomplish this, we can leverage the UserIdentity to create the User Pool (Cognito by default) and Identity Pool. We can then pipe the respective pool id's as runtimeOptions into the StaticWebsite. After the website is deployed, these values can be interrogated from the runtime-config.json deployed alongside the website in order to perform authentication within the app using something like the Amplify Auth API.

const userIdentity = new UserIdentity(this, 'UserIdentity');
new StaticWebsite(this, 'StaticWebsite', {
    websiteContentPath: '<relative>/<path>/<to>/<built>/<website>',
    runtimeOptions: {
        jsonPayload: {
            region: Stack.of(this).region,
            identityPoolId: userIdentity.identityPool.identityPoolId,
            userPoolId: userIdentity.userPool?.userPoolId,
            userPoolWebClientId: userIdentity.userPoolClient?.userPoolClientId,
        }
    },
});

Project details


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

aws_prototyping_sdk.static_website-0.9.4.tar.gz (61.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file aws_prototyping_sdk.static_website-0.9.4.tar.gz.

File metadata

File hashes

Hashes for aws_prototyping_sdk.static_website-0.9.4.tar.gz
Algorithm Hash digest
SHA256 e9e56ff03175d79732ac8a47475196c75ca6bbe38ada5c4ab073e6aae2a2a931
MD5 5be8df11259fc79ace637e4895d1593c
BLAKE2b-256 e50f641eb55e81a3b33a7465ceab3037ff68668a4f9bba07d31995a7c7bd15b2

See more details on using hashes here.

File details

Details for the file aws_prototyping_sdk.static_website-0.9.4-py3-none-any.whl.

File metadata

File hashes

Hashes for aws_prototyping_sdk.static_website-0.9.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f15bc7b3e6c6ef056f90b6195eda7fc9a5972d8b0751ae9b25e57cc08530bce9
MD5 0719f71453bb307828e8db01d136aa0a
BLAKE2b-256 c4d3d6034113374037741a254e178dae41e8247fdd533f03d14232314cea1099

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page