@pulumiverse/cockroach
Version:
A Pulumi package to create and managed Cockroach DB resources in Pulumi programs.
117 lines (116 loc) • 4.02 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* DataDog metric export configuration for a cluster.
*
* ## 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 datadogSite = config.require("datadogSite");
* const datadogApiKey = config.require("datadogApiKey");
* const example = new cockroach.MetricExportDatadogConfig("example", {
* clusterId: clusterId,
* site: datadogSite,
* apiKey: datadogApiKey,
* });
* ```
*
* ## Import
*
* format: <cluster id>
*
* ```sh
* $ pulumi import cockroach:index/metricExportDatadogConfig:MetricExportDatadogConfig example 1f69fdd2-600a-4cfc-a9ba-16995df0d77d
* ```
*/
export declare class MetricExportDatadogConfig extends pulumi.CustomResource {
/**
* Get an existing MetricExportDatadogConfig 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?: MetricExportDatadogConfigState, opts?: pulumi.CustomResourceOptions): MetricExportDatadogConfig;
/**
* Returns true if the given object is an instance of MetricExportDatadogConfig. 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 MetricExportDatadogConfig;
/**
* A Datadog API key.
*/
readonly apiKey: pulumi.Output<string>;
/**
* Cluster ID.
*/
readonly clusterId: pulumi.Output<string>;
/**
* The Datadog region to export to.
*/
readonly site: pulumi.Output<string>;
/**
* Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
*/
readonly status: pulumi.Output<string>;
/**
* Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.
*/
readonly userMessage: pulumi.Output<string>;
/**
* Create a MetricExportDatadogConfig 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: MetricExportDatadogConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering MetricExportDatadogConfig resources.
*/
export interface MetricExportDatadogConfigState {
/**
* A Datadog API key.
*/
apiKey?: pulumi.Input<string>;
/**
* Cluster ID.
*/
clusterId?: pulumi.Input<string>;
/**
* The Datadog region to export to.
*/
site?: pulumi.Input<string>;
/**
* Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
*/
status?: pulumi.Input<string>;
/**
* Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.
*/
userMessage?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a MetricExportDatadogConfig resource.
*/
export interface MetricExportDatadogConfigArgs {
/**
* A Datadog API key.
*/
apiKey: pulumi.Input<string>;
/**
* Cluster ID.
*/
clusterId: pulumi.Input<string>;
/**
* The Datadog region to export to.
*/
site: pulumi.Input<string>;
}