cdk-libs
TypeScript icon, indicating that this package has built-in type declarations

0.1.1 • Public • Published

API Reference

Requirements

Name Link/Command to install
aws cdk https://docs.aws.amazon.com/pt_br/cdk/latest/guide/cli.html
docker https://docs.docker.com/engine/install/ubuntu/
nodeJs https://nodejs.org/en/download/
npm https://www.npmjs.com/get-npm
projen https://www.npmjs.com/package/projen
yarn https://classic.yarnpkg.com/en/docs/install/#windows-stable

Classes

Name Description
Pipeline Define a new pipeline based in pipeline props, by default execute a synth base step, with command standardNpmSynth, this library has integration with code commit and github, which means your source must be in a repository in code commit or github.
LambdaPowerToolsFunction Define a new lambda function based in props provided by your app, this resourse create a structure with canary deploy and a alarm to watch the bahavior of lambda function.


How to usi it ?

Clone this repository from: https://github.com/druid-rio/druid-cdk-construct
Execute the command yarn install , to install the project dependecies, after that execute the command projen to verify if your project it's ok. If you see any error try to check if you have all the dependencies installed.


class Pipeline

This resource is responsable to create and manipulate the stages of your application, the code bellow, represente one way to use this resource in your app.

Properties

Name Description Required
BuildCommand A command to build your code, by defaul execute npm run build. no
DevStageApp It represents a dev stage to construct your app. no
Repository It is a construct repository. no
RepositoryName The name of repository, when this lib is reponsable by create a new repository. no

Initializer

new Pipeline(this, "pipeline", {
            repository: repository,
            buildCommand: 'make cdk-pr',
            qaStage: qaStage
        });

Methods

getProps()

getProps(): as PipelineProps

Returns:

  • {
      repository: code_commit.Repository;
      buildCommand: string;
      repositoryName: string;
      devStageApp: Stage;
    } \

Readme

Keywords

Package Sidebar

Install

npm i cdk-libs

Weekly Downloads

104

Version

0.1.1

License

Apache-2.0

Unpacked Size

1.2 MB

Total Files

344

Last publish

Collaborators

  • geysonferreira