Skip to main content

Zeroscaler CDK TypeScript Construct Library project

npm version PyPI version NuGet version Go project version TypeScript AWS CDK PRs Welcome License: MPL 2.0

The Zeroscaler construct deploys a Lambda function that automatically starts your Fargate application in response to incoming requests. It also handles health monitoring and integrates with an ELB target group.

You can configure the construct using the (ZeroscalerProps) interface, which requires a target group ARN and Fargate task ARN. Optionally, you can also specify a custom VPC and ECS cluster.

Useful commands

  • npm run build compile typescript to js
  • npm run watch watch for changes and compile
  • npm run test perform the jest unit tests

Diagram of the Construct

flowchart TD
    A["Client"] L_A_B_0@-- HTTP Request --> B["Zeroscaler"]
    B -. Register Target .-> C["ELB Target Group"]
    B L_B_A_0@-- Serve HTML with refresh --> A
    C -- Health Check --> D["ECS Fargate"]
    D -- Boot --> E["Your Fargate Application"]
    A L_A_E_0@-- Refresh when booted --> E
    E L_E_A_0@-- Response --> A
    linkStyle 0 stroke:#00C853,fill:none
    linkStyle 1 stroke:#AA00FF,fill:none
    linkStyle 2 stroke:#00C853,fill:none
    linkStyle 3 stroke:#AA00FF,fill:none
    linkStyle 4 stroke:#AA00FF,fill:none
    linkStyle 5 stroke:#2962FF,fill:none
    linkStyle 6 stroke:#2962FF,fill:none
    L_A_B_0@{ animation: fast }
    L_B_A_0@{ animation: fast }
    L_A_E_0@{ animation: fast }
    L_E_A_0@{ animation: fast }

Installation

npm install @zeroscaler/zeroscaler-cdk

Usage

import * as cdk from 'aws-cdk-lib';
import { Construct } from 'constructs';
import { ZeroScaler } from '@zeroscaler/zeroscaler-cdk';

new Zeroscaler(stack, 'MyZeroscaler', {
    targetGroupArn: 'arn:aws:elasticloadbalancing:...',
    fargateTaskArn: 'arn:aws:ecs:...',
    // Optionally override vpc or cluster
    });

License

MPL-2.0

Metadata

Release files for zeroscaler 0.1.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for zeroscaler 0.1.5
File Size Uploaded
zeroscaler-0.1.5.tar.gz 3.9 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for zeroscaler 0.1.5
File Interpreter ABI Platform
zeroscaler-0.1.5-py3-none-any.whl Python 3 none any Details

Total release size: 7.7 MB

Release files / zeroscaler-0.1.5.tar.gz

Download URL zeroscaler-0.1.5.tar.gz
Size 3.9 MB
Tags Source
SHA-256 checksum
How to use checksums
60317ca294249da6540d0a2fd1fe60962c83b5b15421ca785736a0be7c0741c8
BLAKE2b-256 checksum
How to use checksums
5d40c6455c1371954c94e8bd5b42465a1c3fc73739329a274add00b1201ec07f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.3

Release files / zeroscaler-0.1.5-py3-none-any.whl

Download URL zeroscaler-0.1.5-py3-none-any.whl
Size 3.8 MB
Tags Python 3
SHA-256 checksum
How to use checksums
b8a7b11213cb94c3abc477a63d11f257a82ad1c3cbd133f90bf3ac5f36dcb7a2
BLAKE2b-256 checksum
How to use checksums
57d2f26b15b316d934b5d77682aa1cb0ca7d7406e96583fbe5bcc0f9fa33b129
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.3

Release history Release notifications | RSS feed

This release

0.1.5 This release

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page