pulumi-statuspage
Version:
A Pulumi package for creating and managing statuspage cloud resources.
155 lines (154 loc) • 5.13 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as statuspage from "pulumi-statuspage";
*
* const statuspagePingdom = new statuspage.MetricsProvider("statuspagePingdom", {
* apiToken: "a-pingdom-api-token",
* pageId: "pageid",
* type: "Pingdom",
* });
* ```
*
* ## Import
*
* `statuspage_metrics_provider` can be imported using the ID of the metrics provider, e.g.
*
* ```sh
* $ pulumi import statuspage:index/metricsProvider:MetricsProvider statuspage_pingdom my-page-id/my-metrics-provider-id
* ```
*/
export declare class MetricsProvider extends pulumi.CustomResource {
/**
* Get an existing MetricsProvider 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?: MetricsProviderState, opts?: pulumi.CustomResourceOptions): MetricsProvider;
/**
* Returns true if the given object is an instance of MetricsProvider. 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 MetricsProvider;
/**
* Required by the Datadog and NewRelic type metrics providers.
*/
readonly apiKey: pulumi.Output<string | undefined>;
/**
* Required by the Librato and Pingdom-type metrics provider.
*/
readonly apiToken: pulumi.Output<string | undefined>;
/**
* Required by the Pingdom and Datadog type metrics providers.
*/
readonly applicationKey: pulumi.Output<string | undefined>;
/**
* Required by the Librato and Pingdom type metrics providers.
*/
readonly email: pulumi.Output<string | undefined>;
/**
* Required by the NewRelic-type metrics provider
*/
readonly metricBaseUri: pulumi.Output<string | undefined>;
/**
* the id of the page this component belongs to
*/
readonly pageId: pulumi.Output<string>;
/**
* Required by the Pingdom-type metrics provider.
*/
readonly password: pulumi.Output<string | undefined>;
/**
* One of `Pingdom`, `NewRelic`, `Librato`, `Datadog`, or `Self`
*/
readonly type: pulumi.Output<string>;
/**
* Create a MetricsProvider 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: MetricsProviderArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering MetricsProvider resources.
*/
export interface MetricsProviderState {
/**
* Required by the Datadog and NewRelic type metrics providers.
*/
apiKey?: pulumi.Input<string>;
/**
* Required by the Librato and Pingdom-type metrics provider.
*/
apiToken?: pulumi.Input<string>;
/**
* Required by the Pingdom and Datadog type metrics providers.
*/
applicationKey?: pulumi.Input<string>;
/**
* Required by the Librato and Pingdom type metrics providers.
*/
email?: pulumi.Input<string>;
/**
* Required by the NewRelic-type metrics provider
*/
metricBaseUri?: pulumi.Input<string>;
/**
* the id of the page this component belongs to
*/
pageId?: pulumi.Input<string>;
/**
* Required by the Pingdom-type metrics provider.
*/
password?: pulumi.Input<string>;
/**
* One of `Pingdom`, `NewRelic`, `Librato`, `Datadog`, or `Self`
*/
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a MetricsProvider resource.
*/
export interface MetricsProviderArgs {
/**
* Required by the Datadog and NewRelic type metrics providers.
*/
apiKey?: pulumi.Input<string>;
/**
* Required by the Librato and Pingdom-type metrics provider.
*/
apiToken?: pulumi.Input<string>;
/**
* Required by the Pingdom and Datadog type metrics providers.
*/
applicationKey?: pulumi.Input<string>;
/**
* Required by the Librato and Pingdom type metrics providers.
*/
email?: pulumi.Input<string>;
/**
* Required by the NewRelic-type metrics provider
*/
metricBaseUri?: pulumi.Input<string>;
/**
* the id of the page this component belongs to
*/
pageId: pulumi.Input<string>;
/**
* Required by the Pingdom-type metrics provider.
*/
password?: pulumi.Input<string>;
/**
* One of `Pingdom`, `NewRelic`, `Librato`, `Datadog`, or `Self`
*/
type: pulumi.Input<string>;
}