@pulumiverse/grafana/enterprise/dataSourceCacheConfig.d.ts

A Pulumi package for creating and managing grafana.

import * as pulumi from "@pulumi/pulumi";
/**
 * Manages cache configuration for a data source (Grafana Enterprise).
 *
 * Use this resource to enable or disable caching for a particular data source. You can also tune the TTL settings for the cache behaviour, or choose to use defaults.
 *
 * Deleting this resource will cause the cache to be disabled for the target data source.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as grafana from "@pulumiverse/grafana";
 *
 * const loki = new grafana.oss.DataSource("loki", {
 *     type: "loki",
 *     name: "loki",
 *     url: "http://localhost:3100",
 * });
 * const lokiCache = new grafana.enterprise.DataSourceCacheConfig("loki_cache", {
 *     datasourceUid: loki.uid,
 *     enabled: true,
 *     useDefaultTtl: false,
 *     ttlQueriesMs: 60000,
 *     ttlResourcesMs: 300000,
 * });
 * ```
 *
 * ## Import
 *
 * ```sh
 * terraform import grafana_data_source_cache_config.name "{{ datasource_uid }}"
 * terraform import grafana_data_source_cache_config.name "{{ orgID }}:{{ datasource_uid }}"
 * ```
 */
export declare class DataSourceCacheConfig extends pulumi.CustomResource {
    /**
     * Get an existing DataSourceCacheConfig resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DataSourceCacheConfigState, opts?: pulumi.CustomResourceOptions): DataSourceCacheConfig;
    /**
     * Returns true if the given object is an instance of DataSourceCacheConfig.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is DataSourceCacheConfig;
    /**
     * UID of the data source to configure.
     */
    readonly datasourceUid: pulumi.Output<string>;
    /**
     * Whether caching is enabled for this data source.
     */
    readonly enabled: pulumi.Output<boolean | undefined>;
    /**
     * The Organization ID. If not set, the Org ID defined in the provider block will be used.
     */
    readonly orgId: pulumi.Output<string | undefined>;
    /**
     * TTL for query caching, in milliseconds. Ignored if use*default*ttl is true.
     */
    readonly ttlQueriesMs: pulumi.Output<number | undefined>;
    /**
     * TTL for resource caching, in milliseconds. Ignored if use*default*ttl is true.
     */
    readonly ttlResourcesMs: pulumi.Output<number | undefined>;
    /**
     * If true, use Grafana's default TTLs instead of custom values. Defaults to `true`.
     */
    readonly useDefaultTtl: pulumi.Output<boolean | undefined>;
    /**
     * Create a DataSourceCacheConfig resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: DataSourceCacheConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering DataSourceCacheConfig resources.
 */
export interface DataSourceCacheConfigState {
    /**
     * UID of the data source to configure.
     */
    datasourceUid?: pulumi.Input<string>;
    /**
     * Whether caching is enabled for this data source.
     */
    enabled?: pulumi.Input<boolean>;
    /**
     * The Organization ID. If not set, the Org ID defined in the provider block will be used.
     */
    orgId?: pulumi.Input<string>;
    /**
     * TTL for query caching, in milliseconds. Ignored if use*default*ttl is true.
     */
    ttlQueriesMs?: pulumi.Input<number>;
    /**
     * TTL for resource caching, in milliseconds. Ignored if use*default*ttl is true.
     */
    ttlResourcesMs?: pulumi.Input<number>;
    /**
     * If true, use Grafana's default TTLs instead of custom values. Defaults to `true`.
     */
    useDefaultTtl?: pulumi.Input<boolean>;
}
/**
 * The set of arguments for constructing a DataSourceCacheConfig resource.
 */
export interface DataSourceCacheConfigArgs {
    /**
     * UID of the data source to configure.
     */
    datasourceUid: pulumi.Input<string>;
    /**
     * Whether caching is enabled for this data source.
     */
    enabled?: pulumi.Input<boolean>;
    /**
     * The Organization ID. If not set, the Org ID defined in the provider block will be used.
     */
    orgId?: pulumi.Input<string>;
    /**
     * TTL for query caching, in milliseconds. Ignored if use*default*ttl is true.
     */
    ttlQueriesMs?: pulumi.Input<number>;
    /**
     * TTL for resource caching, in milliseconds. Ignored if use*default*ttl is true.
     */
    ttlResourcesMs?: pulumi.Input<number>;
    /**
     * If true, use Grafana's default TTLs instead of custom values. Defaults to `true`.
     */
    useDefaultTtl?: pulumi.Input<boolean>;
}