@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
280 lines (279 loc) • 10.6 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* An HttpsHealthCheck resource. This resource defines a template for how
* individual VMs should be checked for health, via HTTPS.
*
* > **Note:** gcp.compute.HttpsHealthCheck is a legacy health check.
* The newer [gcp.compute.HealthCheck](https://www.terraform.io/docs/providers/google/r/compute_health_check.html)
* should be preferred for all uses except
* [Network Load Balancers](https://cloud.google.com/compute/docs/load-balancing/network/)
* which still require the legacy version.
*
* To get more information about HttpsHealthCheck, see:
*
* * [API documentation](https://cloud.google.com/compute/docs/reference/v1/httpsHealthChecks)
* * How-to Guides
* * [Adding Health Checks](https://cloud.google.com/compute/docs/load-balancing/health-checks#legacy_health_checks)
*
* ## Example Usage
*
* ### Https Health Check Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.compute.HttpsHealthCheck("default", {
* name: "authentication-health-check",
* requestPath: "/health_check",
* timeoutSec: 1,
* checkIntervalSec: 1,
* });
* ```
*
* ## Import
*
* HttpsHealthCheck can be imported using any of these accepted formats:
*
* * `projects/{{project}}/global/httpsHealthChecks/{{name}}`
*
* * `{{project}}/{{name}}`
*
* * `{{name}}`
*
* When using the `pulumi import` command, HttpsHealthCheck can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:compute/httpsHealthCheck:HttpsHealthCheck default projects/{{project}}/global/httpsHealthChecks/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/httpsHealthCheck:HttpsHealthCheck default {{project}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/httpsHealthCheck:HttpsHealthCheck default {{name}}
* ```
*/
export declare class HttpsHealthCheck extends pulumi.CustomResource {
/**
* Get an existing HttpsHealthCheck 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?: HttpsHealthCheckState, opts?: pulumi.CustomResourceOptions): HttpsHealthCheck;
/**
* Returns true if the given object is an instance of HttpsHealthCheck. 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 HttpsHealthCheck;
/**
* How often (in seconds) to send a health check. The default value is 5
* seconds.
*/
readonly checkIntervalSec: pulumi.Output<number | undefined>;
/**
* Creation timestamp in RFC3339 text format.
*/
readonly creationTimestamp: pulumi.Output<string>;
/**
* An optional description of this resource. Provide this property when
* you create the resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* A so-far unhealthy instance will be marked healthy after this many
* consecutive successes. The default value is 2.
*/
readonly healthyThreshold: pulumi.Output<number | undefined>;
/**
* The value of the host header in the HTTPS health check request. If
* left empty (default value), the public IP on behalf of which this
* health check is performed will be used.
*/
readonly host: pulumi.Output<string | undefined>;
/**
* Name of the resource. Provided by the client when the resource is
* created. The name must be 1-63 characters long, and comply with
* RFC1035. Specifically, the name must be 1-63 characters long and
* match the regular expression `a-z?` which means
* the first character must be a lowercase letter, and all following
* characters must be a dash, lowercase letter, or digit, except the
* last character, which cannot be a dash.
*/
readonly name: pulumi.Output<string>;
/**
* The TCP port number for the HTTPS health check request.
* The default value is 443.
*/
readonly port: pulumi.Output<number | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* The request path of the HTTPS health check request.
* The default value is /.
*/
readonly requestPath: pulumi.Output<string | undefined>;
/**
* The URI of the created resource.
*/
readonly selfLink: pulumi.Output<string>;
/**
* How long (in seconds) to wait before claiming failure.
* The default value is 5 seconds. It is invalid for timeoutSec to have
* greater value than checkIntervalSec.
*/
readonly timeoutSec: pulumi.Output<number | undefined>;
/**
* A so-far healthy instance will be marked unhealthy after this many
* consecutive failures. The default value is 2.
*/
readonly unhealthyThreshold: pulumi.Output<number | undefined>;
/**
* Create a HttpsHealthCheck 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?: HttpsHealthCheckArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering HttpsHealthCheck resources.
*/
export interface HttpsHealthCheckState {
/**
* How often (in seconds) to send a health check. The default value is 5
* seconds.
*/
checkIntervalSec?: pulumi.Input<number>;
/**
* Creation timestamp in RFC3339 text format.
*/
creationTimestamp?: pulumi.Input<string>;
/**
* An optional description of this resource. Provide this property when
* you create the resource.
*/
description?: pulumi.Input<string>;
/**
* A so-far unhealthy instance will be marked healthy after this many
* consecutive successes. The default value is 2.
*/
healthyThreshold?: pulumi.Input<number>;
/**
* The value of the host header in the HTTPS health check request. If
* left empty (default value), the public IP on behalf of which this
* health check is performed will be used.
*/
host?: pulumi.Input<string>;
/**
* Name of the resource. Provided by the client when the resource is
* created. The name must be 1-63 characters long, and comply with
* RFC1035. Specifically, the name must be 1-63 characters long and
* match the regular expression `a-z?` which means
* the first character must be a lowercase letter, and all following
* characters must be a dash, lowercase letter, or digit, except the
* last character, which cannot be a dash.
*/
name?: pulumi.Input<string>;
/**
* The TCP port number for the HTTPS health check request.
* The default value is 443.
*/
port?: pulumi.Input<number>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The request path of the HTTPS health check request.
* The default value is /.
*/
requestPath?: pulumi.Input<string>;
/**
* The URI of the created resource.
*/
selfLink?: pulumi.Input<string>;
/**
* How long (in seconds) to wait before claiming failure.
* The default value is 5 seconds. It is invalid for timeoutSec to have
* greater value than checkIntervalSec.
*/
timeoutSec?: pulumi.Input<number>;
/**
* A so-far healthy instance will be marked unhealthy after this many
* consecutive failures. The default value is 2.
*/
unhealthyThreshold?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a HttpsHealthCheck resource.
*/
export interface HttpsHealthCheckArgs {
/**
* How often (in seconds) to send a health check. The default value is 5
* seconds.
*/
checkIntervalSec?: pulumi.Input<number>;
/**
* An optional description of this resource. Provide this property when
* you create the resource.
*/
description?: pulumi.Input<string>;
/**
* A so-far unhealthy instance will be marked healthy after this many
* consecutive successes. The default value is 2.
*/
healthyThreshold?: pulumi.Input<number>;
/**
* The value of the host header in the HTTPS health check request. If
* left empty (default value), the public IP on behalf of which this
* health check is performed will be used.
*/
host?: pulumi.Input<string>;
/**
* Name of the resource. Provided by the client when the resource is
* created. The name must be 1-63 characters long, and comply with
* RFC1035. Specifically, the name must be 1-63 characters long and
* match the regular expression `a-z?` which means
* the first character must be a lowercase letter, and all following
* characters must be a dash, lowercase letter, or digit, except the
* last character, which cannot be a dash.
*/
name?: pulumi.Input<string>;
/**
* The TCP port number for the HTTPS health check request.
* The default value is 443.
*/
port?: pulumi.Input<number>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The request path of the HTTPS health check request.
* The default value is /.
*/
requestPath?: pulumi.Input<string>;
/**
* How long (in seconds) to wait before claiming failure.
* The default value is 5 seconds. It is invalid for timeoutSec to have
* greater value than checkIntervalSec.
*/
timeoutSec?: pulumi.Input<number>;
/**
* A so-far healthy instance will be marked unhealthy after this many
* consecutive failures. The default value is 2.
*/
unhealthyThreshold?: pulumi.Input<number>;
}