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.52.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.52.tar.gz.

File metadata

File hashes

Hashes for aws_prototyping_sdk.static_website-0.19.52.tar.gz
Algorithm Hash digest
SHA256 e9d4dcde7547918ab107d48dcb2fcf93dbe351ae5d69cb2db190b84315b3a0e3
MD5 331a1d69a48b35cdc4a9795edf965f76
BLAKE2b-256 929c213368b5ee59cc8237124ce1d0789ce468c430c3855f0111016e8ef4aeb0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_prototyping_sdk.static_website-0.19.52-py3-none-any.whl
Algorithm Hash digest
SHA256 bfaaf8fde8103bec1cdd2cb85fbb09639a433a26ba4a28937fdbdf8be04348fb
MD5 b77c2a63af67ece68c314c6aabc04fbb
BLAKE2b-256 6457c767e04bb855bd528ceb8b429df8aa12a2c01df365cfab218c06379e8f66

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