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.12.33.tar.gz (61.3 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.12.33.tar.gz.

File metadata

File hashes

Hashes for aws_prototyping_sdk.static_website-0.12.33.tar.gz
Algorithm Hash digest
SHA256 f710990cd19cf7e22905f8f85b7df270e5d3bc25b3a8f3f715c29a065a47e8e5
MD5 42a25ff23ee69c0dbfa0031aa53e357d
BLAKE2b-256 c27a56e24ceaff9e25c5ab7e678ea6cb3f5bdd95b7e5397bccd768cd91426933

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.static_website-0.12.33-py3-none-any.whl
Algorithm Hash digest
SHA256 ddfcba975010bf37c2eaf1605edac9bbd974bd775a89e2321e0a9797e6271daf
MD5 a49e031410e40c6ed5997f8bc78860e9
BLAKE2b-256 d6930a0b5a36149140352ae34be23eff292802342d0683eda6536f8bce46f4f4

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