Overview

• Hosting buckets are ideal for serving static content(such as static website) and client rendered applications to your users across the world.
• Contents of your application are distributed through CDN. By distributing and caching content across 310+ globally dispersed Points of Presence (PoPs - also called edge locations) you can significantly decrease the latency of data delivery as well as reduce load on your application.
• Hosting buckets come secured(with automatic TLS) out of the box
• If your use-case requires more control over bucket configuration take a look at the bucket resource.

Under the hood

Under the hood, the hosting bucket has two main components:

• S3 bucket - an object(file) storage where your assets are uploaded and stored. For more information about S3 refer to AWS docs.
• Cloudfront CDN distribution - distributes and caches your app assets across the world. For more information about Cloudfront refer to AWS docs.

Basic usage

You can configure properties hosting bucket by simply setting upload directory path:

Copy
resources:
  myWebsite:
    type: 'hosting-bucket'
    properties:
      uploadDirectoryPath: ./dist

Hosting content type

You can specify what type of content type you are hosting.

Based of that Stacktape will configure HTTP headers of uploaded files and CDN behavior.

Copy
resources:
  myWebsite:
    type: hosting-bucket
    properties:
      uploadDirectoryPath: ./dist
      hostingContentType: single-page-app

Custom domains

Custom domain names

If you do not have a custom domain and want one, read the section Registering domain on the Domains and TLS certificates page.

If you already have an existing domain and you wish to use it with your app, there are two approaches:

1. Using Stacktape to manage domains and certs - you must use Route53 in your AWS account as your DNS.
2. Using 3rd party DNS provider - such as GoDaddy, Cloudflare etc. You must handle domains and generate certificates yourself.

For more information about domain management options, refer to Domains and TLS certificates page.

Using Stacktape to manage domains and certs

Copy
resources:
  myWebsite:
    type: hosting-bucket
    properties:
      uploadDirectoryPath: ./dist
      hostingContentType: single-page-app
      customDomains:
        - domainName: example.com

Using 3rd party DNS

To use 3rd party provider follow these steps:

1. Create/import a custom TLS certificate for your domain in AWS console. Copy certificate ARN; you will need it in the next step.
2. After the certificate is validated (Issued), assign your domain to your resource:
   • use the ARN of your certificate as customCertificateArn
   • disable DNS record creation (because you are using third party DNS)

Copy
resources:
  myWebsite:
    type: hosting-bucket
    properties:
      uploadDirectoryPath: ./dist
      customDomains:
        - domainName: mydomain.com
          disableDnsRecordCreation: true
          customCertificateArn: <<ARN_OF_YOUR_CERTIFICATE>>

3. After you deploy your hosting bucket, you can find the domain name in Stacktape console in:

   Your project and stage > Click on your Hosting Bucket resource to see its (CDN) domain

   Once you have the domain name, you can point DNS record to this domain using your DNS provider:

   • Use ALIAS record type for root domains (i.e mydomain.com)
   • Use CNAME record type for subdomains (i.e www.mydomain.com or staging.mydomain.com

Edge lambda functions

For more information refer to Edge lambda functions page.

Copy
resources:
  authFunction:
    type: edge-lambda-function
    properties:
      packaging:
        type: stacktape-lambda-buildpack
        properties:
          entryfilePath: auth-function.ts

  myWebsite:
    type: hosting-bucket
    properties:
      edgeFunctions:
        onRequest: authFunction

Referenceable parameters