@pulumi/digitalocean
Version:
A Pulumi package for creating and managing DigitalOcean cloud resources.
109 lines (108 loc) • 4.05 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a [DigitalOcean Uptime Checks](https://docs.digitalocean.com/reference/api/digitalocean/#tag/Uptime)
* resource. Uptime Checks provide the ability to monitor your endpoints from around the world, and alert you when they're slow, unavailable, or SSL certificates are expiring.
*
* ## Import
*
* Uptime checks can be imported using the uptime check's `id`, e.g.
*
* ```sh
* $ pulumi import digitalocean:index/uptimeCheck:UptimeCheck target 5a4981aa-9653-4bd1-bef5-d6bff52042e4
* ```
*/
export declare class UptimeCheck extends pulumi.CustomResource {
/**
* Get an existing UptimeCheck 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?: UptimeCheckState, opts?: pulumi.CustomResourceOptions): UptimeCheck;
/**
* Returns true if the given object is an instance of UptimeCheck. 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 UptimeCheck;
/**
* A boolean value indicating whether the check is enabled/disabled.
*/
readonly enabled: pulumi.Output<boolean | undefined>;
/**
* A human-friendly display name for the check.
*/
readonly name: pulumi.Output<string>;
/**
* An array containing the selected regions to perform healthchecks from: "usEast", "usWest", "euWest", "seAsia"
*/
readonly regions: pulumi.Output<string[] | undefined>;
/**
* The endpoint to perform healthchecks on.
*/
readonly target: pulumi.Output<string>;
/**
* The type of health check to perform: 'ping' 'http' 'https'.
*/
readonly type: pulumi.Output<string | undefined>;
/**
* Create a UptimeCheck 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: UptimeCheckArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering UptimeCheck resources.
*/
export interface UptimeCheckState {
/**
* A boolean value indicating whether the check is enabled/disabled.
*/
enabled?: pulumi.Input<boolean>;
/**
* A human-friendly display name for the check.
*/
name?: pulumi.Input<string>;
/**
* An array containing the selected regions to perform healthchecks from: "usEast", "usWest", "euWest", "seAsia"
*/
regions?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The endpoint to perform healthchecks on.
*/
target?: pulumi.Input<string>;
/**
* The type of health check to perform: 'ping' 'http' 'https'.
*/
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a UptimeCheck resource.
*/
export interface UptimeCheckArgs {
/**
* A boolean value indicating whether the check is enabled/disabled.
*/
enabled?: pulumi.Input<boolean>;
/**
* A human-friendly display name for the check.
*/
name?: pulumi.Input<string>;
/**
* An array containing the selected regions to perform healthchecks from: "usEast", "usWest", "euWest", "seAsia"
*/
regions?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The endpoint to perform healthchecks on.
*/
target: pulumi.Input<string>;
/**
* The type of health check to perform: 'ping' 'http' 'https'.
*/
type?: pulumi.Input<string>;
}