# API Reference
## Constructs
### Dashboard
A Grafana dashboard.
> [https://grafana.com/docs/grafana/latest/http_api/dashboard/](https://grafana.com/docs/grafana/latest/http_api/dashboard/)
#### Initializers
```typescript
import { Dashboard } from 'cdk8s-grafana'
new Dashboard(scope: Construct, id: string, props: DashboardProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | DashboardProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* DashboardProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
| addPlugins | Adds one or more plugins. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `addPlugins`
```typescript
public addPlugins(plugins: ...GrafanaPlugin[]): void
```
Adds one or more plugins.
###### `plugins`Required
- *Type:* ...GrafanaPlugin[]
---
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { Dashboard } from 'cdk8s-grafana'
Dashboard.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
### DataSource
A Grafana data source.
> [https://grafana.com/docs/grafana/latest/administration/provisioning/#example-data-source-config-file](https://grafana.com/docs/grafana/latest/administration/provisioning/#example-data-source-config-file)
#### Initializers
```typescript
import { DataSource } from 'cdk8s-grafana'
new DataSource(scope: Construct, id: string, props: DataSourceProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | DataSourceProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* DataSourceProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { DataSource } from 'cdk8s-grafana'
DataSource.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| name | string | Name of the data source. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `name`Required
```typescript
public readonly name: string;
```
- *Type:* string
Name of the data source.
---
### Grafana
A Grafana instance.
#### Initializers
```typescript
import { Grafana } from 'cdk8s-grafana'
new Grafana(scope: Construct, id: string, props?: GrafanaProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | GrafanaProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Optional
- *Type:* GrafanaProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
| addDashboard | Creates a dashboard associated with a particular data source. |
| addDataSource | Adds a data source. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `addDashboard`
```typescript
public addDashboard(id: string, props: DashboardProps): Dashboard
```
Creates a dashboard associated with a particular data source.
By default,
labels are automatically added so that the data source is detected by
Grafana.
###### `id`Required
- *Type:* string
---
###### `props`Required
- *Type:* DashboardProps
---
##### `addDataSource`
```typescript
public addDataSource(id: string, props: DataSourceProps): DataSource
```
Adds a data source.
By default, labels are automatically added so that
the data source is detected by Grafana.
###### `id`Required
- *Type:* string
---
###### `props`Required
- *Type:* DataSourceProps
---
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { Grafana } from 'cdk8s-grafana'
Grafana.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
## Structs
### DashboardProps
#### Initializer
```typescript
import { DashboardProps } from 'cdk8s-grafana'
const dashboardProps: DashboardProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| title | string | Title of the dashboard. |
| dataSourceVariables | {[ key: string ]: string} | Specify a mapping from data source variables to data source names. |
| folder | string | Group dashboards into folders. |
| jsonModel | {[ key: string ]: any} | All other dashboard customizations. |
| labels | {[ key: string ]: string} | Labels to apply to the kubernetes resource. |
| namespace | string | Namespace to apply to the kubernetes resource. |
| plugins | GrafanaPlugin[] | Specify plugins required by the dashboard. |
| refreshRate | cdk8s.Duration | Auto-refresh interval. |
| timeRange | cdk8s.Duration | Time range for the dashboard, e.g. last 6 hours, last 7 days, etc. |
---
##### `title`Required
```typescript
public readonly title: string;
```
- *Type:* string
Title of the dashboard.
---
##### `dataSourceVariables`Optional
```typescript
public readonly dataSourceVariables: {[ key: string ]: string};
```
- *Type:* {[ key: string ]: string}
- *Default:* no data source variables
Specify a mapping from data source variables to data source names.
This is only needed if you are importing an existing dashboard's JSON
and it specifies variables within an "__inputs" field.
---
*Example*
```typescript
{ DS_PROMETHEUS: "my-prometheus-ds" }
```
##### `folder`Optional
```typescript
public readonly folder: string;
```
- *Type:* string
- *Default:* default folder
Group dashboards into folders.
---
##### `jsonModel`Optional
```typescript
public readonly jsonModel: {[ key: string ]: any};
```
- *Type:* {[ key: string ]: any}
All other dashboard customizations.
> [https://grafana.com/docs/grafana/latest/dashboards/json-model/](https://grafana.com/docs/grafana/latest/dashboards/json-model/)
---
##### `labels`Optional
```typescript
public readonly labels: {[ key: string ]: string};
```
- *Type:* {[ key: string ]: string}
- *Default:* no labels
Labels to apply to the kubernetes resource.
When adding a dashboard to a Grafana instance using `grafana.addDashboard`,
labels provided to Grafana will be automatically applied. Otherwise,
labels must be added manually.
---
##### `namespace`Optional
```typescript
public readonly namespace: string;
```
- *Type:* string
- *Default:* undefined (will be assigned to the 'default' namespace)
Namespace to apply to the kubernetes resource.
When adding a dashboard to a Grafana instance using `grafana.addDashboard`,
the namespace will be automatically inherited.
---
##### `plugins`Optional
```typescript
public readonly plugins: GrafanaPlugin[];
```
- *Type:* GrafanaPlugin[]
Specify plugins required by the dashboard.
---
##### `refreshRate`Optional
```typescript
public readonly refreshRate: Duration;
```
- *Type:* cdk8s.Duration
- *Default:* 5 seconds
Auto-refresh interval.
---
##### `timeRange`Optional
```typescript
public readonly timeRange: Duration;
```
- *Type:* cdk8s.Duration
- *Default:* 6 hours
Time range for the dashboard, e.g. last 6 hours, last 7 days, etc.
---
### DataSourceProps
#### Initializer
```typescript
import { DataSourceProps } from 'cdk8s-grafana'
const dataSourceProps: DataSourceProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| access | AccessType | Access type of the data source. |
| name | string | Name of the data source. |
| type | string | Type of the data source. |
| description | string | Description of the data source. |
| labels | {[ key: string ]: string} | Labels to apply to the kubernetes resource. |
| namespace | string | Namespace to apply to the kubernetes resource. |
| url | string | URL of the data source. |
---
##### `access`Required
```typescript
public readonly access: AccessType;
```
- *Type:* AccessType
Access type of the data source.
---
##### `name`Required
```typescript
public readonly name: string;
```
- *Type:* string
Name of the data source.
---
##### `type`Required
```typescript
public readonly type: string;
```
- *Type:* string
Type of the data source.
---
##### `description`Optional
```typescript
public readonly description: string;
```
- *Type:* string
- *Default:* no description
Description of the data source.
---
##### `labels`Optional
```typescript
public readonly labels: {[ key: string ]: string};
```
- *Type:* {[ key: string ]: string}
- *Default:* no labels
Labels to apply to the kubernetes resource.
When adding a data source to a Grafana instance using `grafana.addDataSource`,
labels provided to Grafana will be automatically applied. Otherwise,
labels must be added manually.
---
##### `namespace`Optional
```typescript
public readonly namespace: string;
```
- *Type:* string
- *Default:* undefined (will be assigned to the 'default' namespace)
Namespace to apply to the kubernetes resource.
When adding a data source to a Grafana instance using `grafana.addDataSource`,
the namespace will be automatically inherited.
---
##### `url`Optional
```typescript
public readonly url: string;
```
- *Type:* string
- *Default:* default url for data source type
URL of the data source.
Most resources besides the 'testdata' data source
type require this field in order to retrieve data.
---
### GrafanaPlugin
#### Initializer
```typescript
import { GrafanaPlugin } from 'cdk8s-grafana'
const grafanaPlugin: GrafanaPlugin = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name | string | Name of the plugin, e.g. "grafana-piechart-panel". |
| version | string | Version of the plugin, e.g. "1.3.6". |
---
##### `name`Required
```typescript
public readonly name: string;
```
- *Type:* string
Name of the plugin, e.g. "grafana-piechart-panel".
---
##### `version`Required
```typescript
public readonly version: string;
```
- *Type:* string
Version of the plugin, e.g. "1.3.6".
---
### GrafanaProps
#### Initializer
```typescript
import { GrafanaProps } from 'cdk8s-grafana'
const grafanaProps: GrafanaProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| adminPassword | string | Default admin password. |
| adminUser | string | Default admin username. |
| defaultDataSource | DataSourceProps | Default data source - equivalent to calling `grafana.addDataSource`. |
| image | string | Specify a custom image for Grafana. |
| ingress | boolean | Create an ingress to provide external access to the Grafana cluster. |
| labels | {[ key: string ]: string} | Labels to apply to all Grafana resources. |
| namespace | string | Namespace to apply to all Grafana resources. |
| requireLogin | boolean | Require login in order to view or manage dashboards. |
| serviceType | string | Type of service to be created (NodePort, ClusterIP or LoadBalancer). |
---
##### `adminPassword`Optional
```typescript
public readonly adminPassword: string;
```
- *Type:* string
- *Default:* "secret"
Default admin password.
---
##### `adminUser`Optional
```typescript
public readonly adminUser: string;
```
- *Type:* string
- *Default:* "root"
Default admin username.
---
##### `defaultDataSource`Optional
```typescript
public readonly defaultDataSource: DataSourceProps;
```
- *Type:* DataSourceProps
- *Default:* no data source added
Default data source - equivalent to calling `grafana.addDataSource`.
---
##### `image`Optional
```typescript
public readonly image: string;
```
- *Type:* string
- *Default:* "public.ecr.aws/ubuntu/grafana:latest"
Specify a custom image for Grafana.
---
##### `ingress`Optional
```typescript
public readonly ingress: boolean;
```
- *Type:* boolean
- *Default:* true
Create an ingress to provide external access to the Grafana cluster.
---
##### `labels`Optional
```typescript
public readonly labels: {[ key: string ]: string};
```
- *Type:* {[ key: string ]: string}
- *Default:* { app: "grafana" }
Labels to apply to all Grafana resources.
---
##### `namespace`Optional
```typescript
public readonly namespace: string;
```
- *Type:* string
- *Default:* undefined (will be assigned to the 'default' namespace)
Namespace to apply to all Grafana resources.
The Grafana Operator must be
installed in this namespace for resources to be recognized.
---
##### `requireLogin`Optional
```typescript
public readonly requireLogin: boolean;
```
- *Type:* boolean
- *Default:* false
Require login in order to view or manage dashboards.
---
##### `serviceType`Optional
```typescript
public readonly serviceType: string;
```
- *Type:* string
- *Default:* ClusterIP
Type of service to be created (NodePort, ClusterIP or LoadBalancer).
---
## Enums
### AccessType
Mode for accessing a data source.
> [https://grafana.com/docs/grafana/latest/administration/provisioning/#example-data-source-config-file](https://grafana.com/docs/grafana/latest/administration/provisioning/#example-data-source-config-file)
#### Members
| **Name** | **Description** |
| --- | --- |
| PROXY | Access via proxy. |
| DIRECT | Access directly (via server or browser in UI). |
---
##### `PROXY`
Access via proxy.
---
##### `DIRECT`
Access directly (via server or browser in UI).
---