@pulumiverse/grafana
Version:
A Pulumi package for creating and managing grafana.
170 lines (169 loc) • 6.41 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as grafana from "@pulumiverse/grafana";
*
* const test = new grafana.connections.MetricsEndpointScrapeJob("test", {
* stackId: "1",
* name: "my-scrape-job",
* enabled: true,
* authenticationMethod: "basic",
* authenticationBasicUsername: "my-username",
* authenticationBasicPassword: "my-password",
* url: "https://grafana.com/metrics",
* scrapeIntervalSeconds: 120,
* });
* ```
*
* ## Import
*
* ```sh
* terraform import grafana_connections_metrics_endpoint_scrape_job.name "{{ stack_id }}:{{ name }}"
* ```
*/
export declare class MetricsEndpointScrapeJob extends pulumi.CustomResource {
/**
* Get an existing MetricsEndpointScrapeJob 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?: MetricsEndpointScrapeJobState, opts?: pulumi.CustomResourceOptions): MetricsEndpointScrapeJob;
/**
* Returns true if the given object is an instance of MetricsEndpointScrapeJob. 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 MetricsEndpointScrapeJob;
/**
* Password for basic authentication, use if scrape job is using basic authentication method
*/
readonly authenticationBasicPassword: pulumi.Output<string | undefined>;
/**
* Username for basic authentication, use if scrape job is using basic authentication method
*/
readonly authenticationBasicUsername: pulumi.Output<string | undefined>;
/**
* Bearer token used for authentication, use if scrape job is using bearer authentication method
*/
readonly authenticationBearerToken: pulumi.Output<string | undefined>;
/**
* Method to pass authentication credentials: basic or bearer.
*/
readonly authenticationMethod: pulumi.Output<string>;
/**
* Whether the metrics endpoint scrape job is enabled or not.
*/
readonly enabled: pulumi.Output<boolean>;
/**
* The name of the metrics endpoint scrape job. Part of the Terraform Resource ID.
*/
readonly name: pulumi.Output<string>;
/**
* Frequency for scraping the metrics endpoint: 30, 60, or 120 seconds.
*/
readonly scrapeIntervalSeconds: pulumi.Output<number>;
/**
* The Stack ID of the Grafana Cloud instance. Part of the Terraform Resource ID.
*/
readonly stackId: pulumi.Output<string>;
/**
* The url to scrape metrics from; a valid HTTPs URL is required.
*/
readonly url: pulumi.Output<string>;
/**
* Create a MetricsEndpointScrapeJob 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: MetricsEndpointScrapeJobArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering MetricsEndpointScrapeJob resources.
*/
export interface MetricsEndpointScrapeJobState {
/**
* Password for basic authentication, use if scrape job is using basic authentication method
*/
authenticationBasicPassword?: pulumi.Input<string>;
/**
* Username for basic authentication, use if scrape job is using basic authentication method
*/
authenticationBasicUsername?: pulumi.Input<string>;
/**
* Bearer token used for authentication, use if scrape job is using bearer authentication method
*/
authenticationBearerToken?: pulumi.Input<string>;
/**
* Method to pass authentication credentials: basic or bearer.
*/
authenticationMethod?: pulumi.Input<string>;
/**
* Whether the metrics endpoint scrape job is enabled or not.
*/
enabled?: pulumi.Input<boolean>;
/**
* The name of the metrics endpoint scrape job. Part of the Terraform Resource ID.
*/
name?: pulumi.Input<string>;
/**
* Frequency for scraping the metrics endpoint: 30, 60, or 120 seconds.
*/
scrapeIntervalSeconds?: pulumi.Input<number>;
/**
* The Stack ID of the Grafana Cloud instance. Part of the Terraform Resource ID.
*/
stackId?: pulumi.Input<string>;
/**
* The url to scrape metrics from; a valid HTTPs URL is required.
*/
url?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a MetricsEndpointScrapeJob resource.
*/
export interface MetricsEndpointScrapeJobArgs {
/**
* Password for basic authentication, use if scrape job is using basic authentication method
*/
authenticationBasicPassword?: pulumi.Input<string>;
/**
* Username for basic authentication, use if scrape job is using basic authentication method
*/
authenticationBasicUsername?: pulumi.Input<string>;
/**
* Bearer token used for authentication, use if scrape job is using bearer authentication method
*/
authenticationBearerToken?: pulumi.Input<string>;
/**
* Method to pass authentication credentials: basic or bearer.
*/
authenticationMethod: pulumi.Input<string>;
/**
* Whether the metrics endpoint scrape job is enabled or not.
*/
enabled?: pulumi.Input<boolean>;
/**
* The name of the metrics endpoint scrape job. Part of the Terraform Resource ID.
*/
name?: pulumi.Input<string>;
/**
* Frequency for scraping the metrics endpoint: 30, 60, or 120 seconds.
*/
scrapeIntervalSeconds?: pulumi.Input<number>;
/**
* The Stack ID of the Grafana Cloud instance. Part of the Terraform Resource ID.
*/
stackId: pulumi.Input<string>;
/**
* The url to scrape metrics from; a valid HTTPs URL is required.
*/
url: pulumi.Input<string>;
}