cdk8s-grafana/lib/datasource.d.ts

Grafana construct for cdk8s.

import { Construct } from 'constructs';
/**
 * Mode for accessing a data source.
 * @see https://grafana.com/docs/grafana/latest/administration/provisioning/#example-data-source-config-file
 */
export declare enum AccessType {
    /**
     * Access via proxy.
     */
    PROXY = "proxy",
    /**
     * Access directly (via server or browser in UI).
     */
    DIRECT = "direct"
}
export interface DataSourceProps {
    /**
     * Name of the data source.
     */
    readonly name: string;
    /**
     * Type of the data source.
     */
    readonly type: string;
    /**
     * Access type of the data source.
     */
    readonly access: AccessType;
    /**
     * Description of the data source.
     * @default - no description
     */
    readonly description?: string;
    /**
     * URL of the data source. Most resources besides the 'testdata' data source
     * type require this field in order to retrieve data.
     *
     * @default - default url for data source type
     */
    readonly url?: string;
    /**
     * 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.
     *
     * @default - no labels
     */
    readonly labels?: {
        [name: string]: string;
    };
    /**
     * 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.
     *
     * @default - undefined (will be assigned to the 'default' namespace)
     */
    readonly namespace?: string;
}
/**
 * A Grafana data source.
 * @see https://grafana.com/docs/grafana/latest/administration/provisioning/#example-data-source-config-file
 */
export declare class DataSource extends Construct {
    /**
     * Name of the data source.
     */
    readonly name: string;
    constructor(scope: Construct, id: string, props: DataSourceProps);
}