@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
304 lines • 13.2 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A health source resource specifies the source resources and the health
* aggregation policy applied to the source resources to determine the
* aggregated health status.
*
* To get more information about RegionHealthSource, see:
*
* * [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/regionHealthSources)
* * How-to Guides
* * [Health checks overview](https://cloud.google.com/load-balancing/docs/health-check-concepts)
*
* ## Example Usage
*
* ### Compute Region Health Source Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const hap = new gcp.compute.RegionHealthAggregationPolicy("hap", {
* name: "test-health-source-hap",
* description: "health aggregation policy for health source",
* region: "us-central1",
* });
* const _default = new gcp.compute.HealthCheck("default", {
* name: "test-health-source-hc",
* httpHealthCheck: {
* port: 80,
* },
* });
* const defaultRegionBackendService = new gcp.compute.RegionBackendService("default", {
* name: "test-health-source-bs",
* region: "us-central1",
* healthChecks: _default.id,
* loadBalancingScheme: "INTERNAL",
* });
* const exampleTestHealthSource = new gcp.compute.RegionHealthSource("example_test_health_source", {
* name: "test-health-source",
* description: "Example health source basic",
* region: "us-central1",
* sourceType: "BACKEND_SERVICE",
* sources: defaultRegionBackendService.id,
* healthAggregationPolicy: hap.id,
* });
* ```
*
* ## Import
*
* RegionHealthSource can be imported using any of these accepted formats:
*
* * `projects/{{project}}/regions/{{region}}/healthSources/{{name}}`
* * `{{project}}/{{region}}/{{name}}`
* * `{{region}}/{{name}}`
* * `{{name}}`
*
* When using the `pulumi import` command, RegionHealthSource can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:compute/regionHealthSource:RegionHealthSource default projects/{{project}}/regions/{{region}}/healthSources/{{name}}
* $ pulumi import gcp:compute/regionHealthSource:RegionHealthSource default {{project}}/{{region}}/{{name}}
* $ pulumi import gcp:compute/regionHealthSource:RegionHealthSource default {{region}}/{{name}}
* $ pulumi import gcp:compute/regionHealthSource:RegionHealthSource default {{name}}
* ```
*/
export declare class RegionHealthSource extends pulumi.CustomResource {
/**
* Get an existing RegionHealthSource 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?: RegionHealthSourceState, opts?: pulumi.CustomResourceOptions): RegionHealthSource;
/**
* Returns true if the given object is an instance of RegionHealthSource. 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 RegionHealthSource;
/**
* Creation timestamp in RFC3339 text format.
*/
readonly creationTimestamp: pulumi.Output<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* An optional description of this resource. Provide this property when you
* create the resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Fingerprint of this resource. A hash of the contents stored in this object.
* This field is used in optimistic locking.
*/
readonly fingerprint: pulumi.Output<string>;
/**
* URL to the `HealthAggregationPolicy` resource. Must be set. Must
* be regional and in the same region as the `HealthSource`. Can be
* mutated.
*/
readonly healthAggregationPolicy: 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 ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* URL of the region where the health source resides.
*/
readonly region: pulumi.Output<string>;
/**
* Server-defined URL with id for the resource.
*/
readonly selfLinkWithId: pulumi.Output<string>;
/**
* Specifies the type of the `HealthSource`. The only allowed value
* is `BACKEND_SERVICE`. Must be specified when the
* `HealthSource` is created, and cannot be mutated.
* Possible values are: `BACKEND_SERVICE`.
*/
readonly sourceType: pulumi.Output<string>;
/**
* URLs to the source resources. Must be size 1. Must be a
* `BackendService` if the `sourceType` is `BACKEND_SERVICE`. The
* `BackendService` must have load balancing scheme
* `INTERNAL` or `INTERNAL_MANAGED` and must be regional
* and in the same region as the `HealthSource` (cross-region
* deployment for `INTERNAL_MANAGED` is not supported). The
* `BackendService` may use only IGs, MIGs, or NEGs of type
* `GCE_VM_IP` or `GCE_VM_IP_PORT`. The
* `BackendService` may not use `haPolicy`. Can be
* mutated.
*/
readonly sources: pulumi.Output<string | undefined>;
/**
* Create a RegionHealthSource 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: RegionHealthSourceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RegionHealthSource resources.
*/
export interface RegionHealthSourceState {
/**
* Creation timestamp in RFC3339 text format.
*/
creationTimestamp?: pulumi.Input<string | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* An optional description of this resource. Provide this property when you
* create the resource.
*/
description?: pulumi.Input<string | undefined>;
/**
* Fingerprint of this resource. A hash of the contents stored in this object.
* This field is used in optimistic locking.
*/
fingerprint?: pulumi.Input<string | undefined>;
/**
* URL to the `HealthAggregationPolicy` resource. Must be set. Must
* be regional and in the same region as the `HealthSource`. Can be
* mutated.
*/
healthAggregationPolicy?: pulumi.Input<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.
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* URL of the region where the health source resides.
*/
region?: pulumi.Input<string | undefined>;
/**
* Server-defined URL with id for the resource.
*/
selfLinkWithId?: pulumi.Input<string | undefined>;
/**
* Specifies the type of the `HealthSource`. The only allowed value
* is `BACKEND_SERVICE`. Must be specified when the
* `HealthSource` is created, and cannot be mutated.
* Possible values are: `BACKEND_SERVICE`.
*/
sourceType?: pulumi.Input<string | undefined>;
/**
* URLs to the source resources. Must be size 1. Must be a
* `BackendService` if the `sourceType` is `BACKEND_SERVICE`. The
* `BackendService` must have load balancing scheme
* `INTERNAL` or `INTERNAL_MANAGED` and must be regional
* and in the same region as the `HealthSource` (cross-region
* deployment for `INTERNAL_MANAGED` is not supported). The
* `BackendService` may use only IGs, MIGs, or NEGs of type
* `GCE_VM_IP` or `GCE_VM_IP_PORT`. The
* `BackendService` may not use `haPolicy`. Can be
* mutated.
*/
sources?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a RegionHealthSource resource.
*/
export interface RegionHealthSourceArgs {
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* An optional description of this resource. Provide this property when you
* create the resource.
*/
description?: pulumi.Input<string | undefined>;
/**
* URL to the `HealthAggregationPolicy` resource. Must be set. Must
* be regional and in the same region as the `HealthSource`. Can be
* mutated.
*/
healthAggregationPolicy?: pulumi.Input<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.
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* URL of the region where the health source resides.
*/
region: pulumi.Input<string>;
/**
* Specifies the type of the `HealthSource`. The only allowed value
* is `BACKEND_SERVICE`. Must be specified when the
* `HealthSource` is created, and cannot be mutated.
* Possible values are: `BACKEND_SERVICE`.
*/
sourceType: pulumi.Input<string>;
/**
* URLs to the source resources. Must be size 1. Must be a
* `BackendService` if the `sourceType` is `BACKEND_SERVICE`. The
* `BackendService` must have load balancing scheme
* `INTERNAL` or `INTERNAL_MANAGED` and must be regional
* and in the same region as the `HealthSource` (cross-region
* deployment for `INTERNAL_MANAGED` is not supported). The
* `BackendService` may use only IGs, MIGs, or NEGs of type
* `GCE_VM_IP` or `GCE_VM_IP_PORT`. The
* `BackendService` may not use `haPolicy`. Can be
* mutated.
*/
sources?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=regionHealthSource.d.ts.map