Categorygithub.com/fogfish/go-cdk-easycdn/easycdn
modulepackage
0.2.2
Repository: https://github.com/fogfish/go-cdk-easycdn.git
Documentation: pkg.go.dev

# README

EasyCDN

EasyCDN is AWS CDK L3 Construct that takes care about configuration of the infrastructure required to securely deliver content through AWS CloudFront.

Build Status Git Hub Coverage Status npm

Inspiration

AWS CloudFront is a convenient approach for static content distribution. Unfortunately, it requires a boilerplate AWS CDK code to bootstrap the provisioning of required resources. This L3 Construct implements a high-order components on top of AWS CDK that simplify the deployment.

It is implemented as using jsii, making it available

Getting started

The latest version of the library is available at its main branch. All development, including new features and bug fixes, take place on the main branch using forking and pull requests as described in contribution guidelines.

npm install --save easycdn

Example of usage

import * as easy from 'easycdn'
const stack = new cdk.Stack(app, 'test', { /* ... */ })

// creation of CDN requires definition of
//  - site name
//  - tls certificate arn
const cdn = new easy.Cdn(stack, 'CDN',
  'cdn.example.com',
  'arn:aws:acm:us-east-1:000000000000:certificate/xxxxxxxx-xx...xxxx',
)

HowTo Contribute

The project is MIT licensed and accepts contributions via GitHub pull requests:

  1. Fork it and clone
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request
git clone https://github.com/fogfish/easycdn
cd easycdn

npm install
npm run build
npm run test
npm run lint

HowTo Release Runtime

npm run build
npm run package

cp -R dist/go/easycdn github.com/fogfish/go-cdk-easycdn

License

See LICENSE

# Packages

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

# Functions

Checks if `x` is a construct.
No description provided by the author
No description provided by the author

# Structs

No description provided by the author

# Interfaces

No description provided by the author