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: '../<path>/<to>/<built>/<website>',
    runtimeOptions: {
        jsonPayload: {
            identityPoolId: userIdentity.identityPool.identityPoolId,
            userPoolId: userIdentity.userPool?.userPoolId,
            userPoolClientId: 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.0.79.tar.gz (57.0 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.0.79.tar.gz.

File metadata

File hashes

Hashes for aws_prototyping_sdk.static_website-0.0.79.tar.gz
Algorithm Hash digest
SHA256 890e1b85f97caca0a7aa1f1d27a89899edb33833b512ef871a0a2ff4276db17a
MD5 c25a13401f7e3c30ad2b524a5132e88f
BLAKE2b-256 becd6a830cdb68b64ec64208531e3232d3cefb93b1baf627f7bdf361a3b11a5e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.static_website-0.0.79-py3-none-any.whl
Algorithm Hash digest
SHA256 49c06982ca77cc0f3dca445b16bdcd929a7bdd6690e5378c2589a9ea26bfbb87
MD5 06afc63f3f985e3e97879021a82b326b
BLAKE2b-256 320f87b3d98bc19c6c8f6bbd7908a89416364765853f39b3c4193e27db2979d0

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