UNPKG

@pulumiverse/cockroach

Version:

A Pulumi package to create and managed Cockroach DB resources in Pulumi programs.

85 lines (84 loc) 3.26 kB
import * as pulumi from "@pulumi/pulumi"; /** * Prometheus metric export configuration for a cluster. This is only available for dedicated clusters with AWS and GCP cloud providers. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as cockroach from "@pulumiverse/cockroach"; * * const config = new pulumi.Config(); * const clusterId = config.require("clusterId"); * const example = new cockroach.MetricExportPrometheusConfig("example", {clusterId: clusterId}); * ``` * * ## Import * * format: <cluster id> * * ```sh * $ pulumi import cockroach:index/metricExportPrometheusConfig:MetricExportPrometheusConfig example 1f69fdd2-600a-4cfc-a9ba-16995df0d77d * ``` */ export declare class MetricExportPrometheusConfig extends pulumi.CustomResource { /** * Get an existing MetricExportPrometheusConfig 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?: MetricExportPrometheusConfigState, opts?: pulumi.CustomResourceOptions): MetricExportPrometheusConfig; /** * Returns true if the given object is an instance of MetricExportPrometheusConfig. 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 MetricExportPrometheusConfig; /** * Cluster ID. */ readonly clusterId: pulumi.Output<string>; /** * The current state of the metric export configuration. Possible values are: [`NOT_DEPLOYED` `DISABLING` `ENABLING` `ENABLED` `ERROR`] */ readonly status: pulumi.Output<string>; readonly targets: pulumi.Output<{ [key: string]: string; }>; /** * Create a MetricExportPrometheusConfig 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: MetricExportPrometheusConfigArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering MetricExportPrometheusConfig resources. */ export interface MetricExportPrometheusConfigState { /** * Cluster ID. */ clusterId?: pulumi.Input<string>; /** * The current state of the metric export configuration. Possible values are: [`NOT_DEPLOYED` `DISABLING` `ENABLING` `ENABLED` `ERROR`] */ status?: pulumi.Input<string>; targets?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; } /** * The set of arguments for constructing a MetricExportPrometheusConfig resource. */ export interface MetricExportPrometheusConfigArgs { /** * Cluster ID. */ clusterId: pulumi.Input<string>; }