Metadata-Version: 2.1
Name: halloumi-cloudwatch-dashboard
Version: 1.1.0
Summary: halloumi-cloudwatch-dashboard
Home-page: https://github.com/sentiampc/halloumi-cloudwatch-dashboard.git
Author: Sentia MPC<support.mpc@sentia.com>
License: Apache-2.0
Project-URL: Source, https://github.com/sentiampc/halloumi-cloudwatch-dashboard.git
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: JavaScript
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Typing :: Typed
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aws-cdk.aws-autoscaling (<2.0.0,>=1.110.0)
Requires-Dist: aws-cdk.aws-cloudwatch (<2.0.0,>=1.110.0)
Requires-Dist: aws-cdk.aws-elasticache (<2.0.0,>=1.110.0)
Requires-Dist: aws-cdk.aws-elasticloadbalancingv2 (<2.0.0,>=1.110.0)
Requires-Dist: aws-cdk.aws-rds (<2.0.0,>=1.110.0)
Requires-Dist: aws-cdk.core (<2.0.0,>=1.110.0)
Requires-Dist: constructs (<4.0.0,>=3.2.27)
Requires-Dist: jsii (<2.0.0,>=1.46.0)
Requires-Dist: publication (>=0.0.3)

# Halloumi Cloudwatch Dashboard

Create a dashboard in the AWS Cloudwatch using the best practices from Halloumi.

## Install

From pip:

```bash
pip install halloumi-cloudwatch-dashboard
```

From npm:

```bash
npm install halloumi-cloudwatch-dashboard
```

## API Documentation

Check [API Documentation](./API.md)

## Usage

### Python

```python
from aws_cdk import core
from halloumi-cloudwatch-dashboard import Dashboard

app = core.App()

stack = core.Stack(app, 'MainStack')
...

Dashboard(
    stack,
    'Dashboard',
    dashboardName='MyDashboard'
)
```

### Typescript

```python
# Example automatically generated from non-compiling source. May contain errors.
import aws_cdk.core as cdk
from halloumi_cloudwatch_dashboard import Dashboard

class CdkWorkshopStack(cdk.Stack):
    def __init__(self, scope, id, *, description=None, env=None, stackName=None, tags=None, synthesizer=None, terminationProtection=None, analyticsReporting=None):
        super().__init__(scope, id, description=description, env=env, stackName=stackName, tags=tags, synthesizer=synthesizer, terminationProtection=terminationProtection, analyticsReporting=analyticsReporting)

        Dashboard(self, "Dashboard", dashboard_name = "MyDashboard")
```


