platform-constructs v0.0.8

README

platform-constructs

What is this repository for?

• Custom AWS Components following best practices for Developer use as objects in projects

Constructs

• ServerlessWebsite

Serverless Website Components

• Route 53 Domain Hosting
• Web Application Firewall with Filtering Rules
• CloudFront with SSL
• S3 Bucket with Encryption to host Static Files

Serverless Website Usage

npm install -g aws-cdk@1.93.0
mkdir website
cd website
npm install platform-constructs
cdk init --language typescript

Serverless Website Parameters

• websiteFolder -> folder that contains website artifacts
• hook -> CLI command to run before synthesizing cloud formation templates
• stage -> environment to deploy to -> dev | test | prod
• domain -> domain name for the hosted zone
• bucketName -> name of s3 Bucket to host website assets

Helper Functions

• createDomainName - create a domain name in the format 'MICROFRONTEND_SERRVICE_NAME-ui.STAGE.apps.DOMAIN'
• createBucketName - create a bucket name in the format 'AWS_ACCOUNT_NUMBER-AWS_REGION-MICROFRONTEND_SERVICE_NAME-STAGE'

Who do I talk to?

• jacob.itegboje@imageapi.com
• nathan.cazell@imageapi.com