@pulumiverse/grafana
Version:
A Pulumi package for creating and managing grafana.
102 lines (101 loc) • 3.71 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages Grafana Fleet Management pipelines.
*
* * [Official documentation](https://grafana.com/docs/grafana-cloud/send-data/fleet-management/)
* * [API documentation](https://grafana.com/docs/grafana-cloud/send-data/fleet-management/api-reference/pipeline-api/)
*
* Required access policy scopes:
*
* * fleet-management:read
* * fleet-management:write
*
* ## Import
*
* ```sh
* $ pulumi import grafana:fleetManagement/pipeline:Pipeline name "{{ name }}"
* ```
*/
export declare class Pipeline extends pulumi.CustomResource {
/**
* Get an existing Pipeline 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?: PipelineState, opts?: pulumi.CustomResourceOptions): Pipeline;
/**
* Returns true if the given object is an instance of Pipeline. 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 Pipeline;
/**
* Configuration contents of the pipeline to be used by collectors
*/
readonly contents: pulumi.Output<string>;
/**
* Whether the pipeline is enabled for collectors
*/
readonly enabled: pulumi.Output<boolean>;
/**
* Used to match against collectors and assign pipelines to them; follows the syntax of Prometheus Alertmanager matchers
*/
readonly matchers: pulumi.Output<string[]>;
/**
* Name of the pipeline which is the unique identifier for the pipeline
*/
readonly name: pulumi.Output<string>;
/**
* Create a Pipeline 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: PipelineArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Pipeline resources.
*/
export interface PipelineState {
/**
* Configuration contents of the pipeline to be used by collectors
*/
contents?: pulumi.Input<string>;
/**
* Whether the pipeline is enabled for collectors
*/
enabled?: pulumi.Input<boolean>;
/**
* Used to match against collectors and assign pipelines to them; follows the syntax of Prometheus Alertmanager matchers
*/
matchers?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Name of the pipeline which is the unique identifier for the pipeline
*/
name?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Pipeline resource.
*/
export interface PipelineArgs {
/**
* Configuration contents of the pipeline to be used by collectors
*/
contents: pulumi.Input<string>;
/**
* Whether the pipeline is enabled for collectors
*/
enabled?: pulumi.Input<boolean>;
/**
* Used to match against collectors and assign pipelines to them; follows the syntax of Prometheus Alertmanager matchers
*/
matchers?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Name of the pipeline which is the unique identifier for the pipeline
*/
name?: pulumi.Input<string>;
}