Metadata-Version: 2.2
Name: aibs-informatics-cdk-lib
Version: 0.1.0
Summary: CDK Library for AIBS Informatics services
Author-email: AIBS Informatics Group <marmot@alleninstitute.onmicrosoft.com>
Maintainer-email: AIBS Informatics Group <marmot@alleninstitute.onmicrosoft.com>
License: Allen Institute Software License – This software license is the 2-clause BSD 
        license plus a third clause that prohibits redistribution and use for 
        commercial purposes without further permission. 
        
        Copyright © 2024. Allen Institute.  All rights reserved.
        
        Redistribution and use in source and binary forms, with or without 
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this 
        list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice, 
        this list of conditions and the following disclaimer in the documentation 
        and/or other materials provided with the distribution.
        
        3. Redistributions and use for commercial purposes are not permitted without 
        the Allen Institute’s written permission. For purposes of this license, 
        commercial purposes are the incorporation of the Allen Institute's software 
        into anything for which you will charge fees or other compensation or use of 
        the software to perform a commercial service for a third party. Contact 
        terms@alleninstitute.org for commercial licensing opportunities.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
        ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Project-URL: Documentation, https://.github.io/aibs-informatics-cdk-lib/
Project-URL: Homepage, https://github.com/AllenInstitute/aibs-informatics-cdk-lib/
Project-URL: Issues, https://github.com/AllenInstitute/aibs-informatics-cdk-lib/issues
Project-URL: Repository, https://github.com/AllenInstitute/aibs-informatics-cdk-lib/
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aibs-informatics-aws-utils~=0.0.4
Requires-Dist: aibs-informatics-core~=0.0.8
Requires-Dist: aws-cdk-lib~=2.96
Requires-Dist: constructs~=10.0
Requires-Dist: pydantic~=2.0
Provides-Extra: dev
Requires-Dist: aibs-informatics-test-resources[all]~=0.0.4; extra == "dev"
Requires-Dist: boto3-stubs[batch,s3]; extra == "dev"
Requires-Dist: mypy~=1.13.0; extra == "dev"
Provides-Extra: release
Requires-Dist: build; extra == "release"
Requires-Dist: bump-my-version; extra == "release"
Requires-Dist: wheel; extra == "release"

# AIBS Informatics CDK Library

[![Build Status](https://github.com/AllenInstitute/aibs-informatics-cdk-lib/actions/workflows/build.yml/badge.svg)](https://github.com/AllenInstitute/aibs-informatics-cdk-lib/actions/workflows/build.yml)
[![codecov](https://codecov.io/gh/AllenInstitute/aibs-informatics-cdk-lib/graph/badge.svg?token=5XCVULUK3E)](https://codecov.io/gh/AllenInstitute/aibs-informatics-cdk-lib)

---

## Overview

The AIBS Informatics CDK Library is a collection of AWS Cloud Development Kit (CDK) constructs and utilities designed to facilitate the deployment and management of cloud infrastructure for the Allen Institute for Brain Science. This library includes constructs for managing AWS Batch environments, Elastic File System (EFS) configurations, CloudWatch dashboards, and more. It aims to provide reusable and configurable components to streamline the development and deployment of cloud-based applications and services.

### Modules

- **Batch**: Constructs for setting up and managing AWS Batch environments, including job queues, compute environments, and monitoring.
- **EFS**: Utilities and constructs for configuring and managing Elastic File System (EFS) resources.
- **CloudWatch**: Tools for creating and managing CloudWatch dashboards and alarms.
- **Service Compute**: Constructs for defining compute resources, including Lambda functions and Batch compute environments.
- **State Machine Fragments**: Reusable fragments for AWS Step Functions, including batch job submission and data synchronization.
- **Assets**: Definitions and utilities for managing code assets, including Lambda functions and Docker images.
- **Core**: Base constructs and utilities used across the library, including environment configurations and common IAM policies.

## Contributing

Any and all PRs are welcome. Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information.

## Licensing

This software is licensed under the Allen Institute Software License, which is the 2-clause BSD license plus a third clause that prohibits redistribution and use for commercial purposes without further permission. For more information, please visit [Allen Institute Terms of Use](https://alleninstitute.org/terms-of-use/).
