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.19.51.tar.gz (109.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.19.51.tar.gz.

File metadata

File hashes

Hashes for aws_prototyping_sdk.static_website-0.19.51.tar.gz
Algorithm Hash digest
SHA256 5d0a4066873640baacdd70047a3f524377574f2792e515ab65da0777d4f056ff
MD5 c723d9d8783f69cc2f4952f968d74284
BLAKE2b-256 219863cd0ab336f9bf5ea6e20c98564f5f9d93cd6d9e08699e0ae05fd3427927

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.static_website-0.19.51-py3-none-any.whl
Algorithm Hash digest
SHA256 e1fcec0bc8058a3b1f9e9e74a58924b1fecf9edcb2072d17ef011620bd9ccb75
MD5 2bf9988f1842deaba4e702ad93b7b0ed
BLAKE2b-256 9242538f5b79ceacd94b59d8f07b4f2f5c36681d02fcda4c0c0e23c617edf816

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