Categorygithub.com/helbing/astrojs-aws-go/construct
modulepackage
0.0.20
Repository: https://github.com/helbing/astrojs-aws-go.git
Documentation: pkg.go.dev

# README

Astro Construct Library

---

cdk-constructs: Experimental

The APIs of higher level constructs in this module are experimental and under active development. They are subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model and breaking changes will be announced in the release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.


Introduction

Astro is the all-in-one web framework designed for speed. This library is supported modes, static, lambda and edge, to deploy astro website to AWS.

Usage

Static Hosting

Static Hosting

For developing, it's not recommended to deploy with CloudFront, because setup CloudFront is really too slow, at least takes 5min.

import "github.com/helbing/astrojs-aws-go/construct"


site := construct.NewStaticAstroSite(this, jsii.String("Site"), &StaticAstroSiteProps{
	SiteDir: jsii.String("/path/to/dist"),
})

awscdk.NewCfnOutput(this, jsii.String("Domains"), &CfnOutputProps{
	Value: site.Domains.join(jsii.String(", ")),
})

It's recommended to deploy with CloudFront in production environment.

import "github.com/helbing/astrojs-aws-go/construct"


site := construct.NewStaticAstroSite(this, jsii.String("Site"), &StaticAstroSiteProps{
	SiteDir: jsii.String("/path/to/dist"),
	CfOptions: &CfOptions{
		Domain: jsii.String("example.com"),
		CertificateArn: jsii.String("arn:aws:acm:us-east-1:xxx-xxx-xxx"),
	},
})

awscdk.NewCfnOutput(this, jsii.String("Domains"), &CfnOutputProps{
	Value: site.Domains.join(jsii.String(", ")),
})

Lambda Hosting

Lambda Hosting

import "github.com/helbing/astrojs-aws-go/construct"


site := construct.NewLambdaAstroSite(this, jsii.String("Site"), &LambdaAstroSiteProps{
	ServerEntry: jsii.String("/path/to/server/entry.mjs"),
	StaticDir: jsii.String("/path/to/client"),
})

awscdk.NewCfnOutput(this, jsii.String("Domains"), &CfnOutputProps{
	Value: site.Domains.join(jsii.String(", ")),
})

Deploy with CloudFront.

import "github.com/helbing/astrojs-aws-go/construct"


site := construct.NewLambdaAstroSite(this, jsii.String("Site"), &LambdaAstroSiteProps{
	ServerEntry: jsii.String("/path/to/server/entry.mjs"),
	StaticDir: jsii.String("/path/to/client"),
	CfOptions: &CfOptions{
		Domain: jsii.String("example.com"),
		CertificateArn: jsii.String("arn:aws:acm:us-east-1:xxx-xxx-xxx"),
	},
})

awscdk.NewCfnOutput(this, jsii.String("Domains"), &CfnOutputProps{
	Value: site.Domains.join(jsii.String(", ")),
})

Edge Hosting

Edge Hosting

As we known that, edge function working in Edge node. But for developing, setup CloudFront is really too slow. We can only deploy the Lambda function, and use AWS SAM for testing and debuging.

import "github.com/helbing/astrojs-aws-go/construct"


construct.NewEdgeAstroSite(this, jsii.String("Site"), &EdgeAstroSiteProps{
	ServerEntry: jsii.String("/path/to/server/entry.mjs"),
	StaticDir: jsii.String("/path/to/client"),
	OnlyLambda: jsii.Boolean(true),
})

Deploy to production environment.

import "github.com/helbing/astrojs-aws-go/construct"


site := construct.NewEdgeAstroSite(this, jsii.String("Site"), &EdgeAstroSiteProps{
	ServerEntry: jsii.String("/path/to/server/entry.mjs"),
	StaticDir: jsii.String("/path/to/client"),
	CfOptions: &CfOptions{
		Domain: jsii.String("example.com"),
		CertificateArn: jsii.String("arn:aws:acm:us-east-1:xxx-xxx-xxx"),
	},
})

awscdk.NewCfnOutput(this, jsii.String("Domains"), &CfnOutputProps{
	Value: site.Domains.join(jsii.String(", ")),
})

# Packages

Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.

# Functions

Checks if `x` is a construct.
Checks if `x` is a construct.
Checks if `x` is a construct.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Experimental.
Checks if `x` is a construct.

# Structs

The options for the Assets.
CloudFront options.
The options for the EdgeAstroSite.
The options for the CloudFront distribution.
The options for the LambdaAstroSite.
The options for the lambda function.
The options for the StaticAstroSite.

# Interfaces

The base class for all constructs.
Experimental.
Experimental.
Experimental.