@pulumiverse/grafana
Version:
A Pulumi package for creating and managing grafana.
101 lines (100 loc) • 3.03 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as grafana from "@pulumiverse/grafana";
*
* const dsTest = grafana.connections.getMetricsEndpointScrapeJob({
* stackId: "1",
* name: "my-scrape-job",
* });
* ```
*/
export declare function getMetricsEndpointScrapeJob(args: GetMetricsEndpointScrapeJobArgs, opts?: pulumi.InvokeOptions): Promise<GetMetricsEndpointScrapeJobResult>;
/**
* A collection of arguments for invoking getMetricsEndpointScrapeJob.
*/
export interface GetMetricsEndpointScrapeJobArgs {
/**
* The name of the Metrics Endpoint Scrape Job. Part of the Terraform Resource ID.
*/
name: string;
/**
* The Stack ID of the Grafana Cloud instance. Part of the Terraform Resource ID.
*/
stackId: string;
}
/**
* A collection of values returned by getMetricsEndpointScrapeJob.
*/
export interface GetMetricsEndpointScrapeJobResult {
/**
* Password for basic authentication.
*/
readonly authenticationBasicPassword: string;
/**
* Username for basic authentication.
*/
readonly authenticationBasicUsername: string;
/**
* Token for authentication bearer.
*/
readonly authenticationBearerToken: string;
/**
* Method to pass authentication credentials: basic or bearer.
*/
readonly authenticationMethod: string;
/**
* Whether the metrics endpoint scrape job is enabled or not.
*/
readonly enabled: boolean;
/**
* The Terraform Resource ID. This has the format "{{ stackId }}:{{ name }}".
*/
readonly id: string;
/**
* The name of the Metrics Endpoint Scrape Job. Part of the Terraform Resource ID.
*/
readonly name: string;
/**
* Frequency for scraping the metrics endpoint: 30, 60, or 120 seconds.
*/
readonly scrapeIntervalSeconds: number;
/**
* The Stack ID of the Grafana Cloud instance. Part of the Terraform Resource ID.
*/
readonly stackId: string;
/**
* The url to scrape metrics.
*/
readonly url: string;
}
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as grafana from "@pulumiverse/grafana";
*
* const dsTest = grafana.connections.getMetricsEndpointScrapeJob({
* stackId: "1",
* name: "my-scrape-job",
* });
* ```
*/
export declare function getMetricsEndpointScrapeJobOutput(args: GetMetricsEndpointScrapeJobOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetMetricsEndpointScrapeJobResult>;
/**
* A collection of arguments for invoking getMetricsEndpointScrapeJob.
*/
export interface GetMetricsEndpointScrapeJobOutputArgs {
/**
* The name of the Metrics Endpoint Scrape Job. Part of the Terraform Resource ID.
*/
name: pulumi.Input<string>;
/**
* The Stack ID of the Grafana Cloud instance. Part of the Terraform Resource ID.
*/
stackId: pulumi.Input<string>;
}