import * as pulumi from "@pulumi/pulumi"; /** * The Health Aggregation Policy specifies how to aggregate the service's constituent source health status to determine an aggregated health status result for the service. For example, you can specify a criteria such as “Consider the Health Source as `Healthy` if there are at least 5 healthy backend endpoints”. Or, you can specify a criteria like “Consider the Health Source as `Healthy` if minimum 60% of endpoints in the Backend are healthy”. The Health Aggregation Policy is applied to each Health Source (e.g. Backend Service) individually. * * To get more information about RegionHealthAggregationPolicy, see: * * * [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/healthAggregationPolicies) * * How-to Guides * * [Health checks overview](https://cloud.google.com/load-balancing/docs/health-check-concepts) * * ## Example Usage * * ### Compute Region Health Aggregation Policy Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const project = gcp.organizations.getProject({}); * const exampleTestHealthAggregationPolicy = new gcp.compute.RegionHealthAggregationPolicy("example_test_health_aggregation_policy", { * name: "test-health-aggregation-policy", * description: "Example health aggregation policy basic", * region: "us-central1", * }); * ``` * * ## Import * * RegionHealthAggregationPolicy can be imported using any of these accepted formats: * * * `projects/{{project}}/regions/{{region}}/healthAggregationPolicies/{{name}}` * * `{{project}}/{{region}}/{{name}}` * * `{{region}}/{{name}}` * * `{{name}}` * * When using the `pulumi import` command, RegionHealthAggregationPolicy can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:compute/regionHealthAggregationPolicy:RegionHealthAggregationPolicy default projects/{{project}}/regions/{{region}}/healthAggregationPolicies/{{name}} * $ pulumi import gcp:compute/regionHealthAggregationPolicy:RegionHealthAggregationPolicy default {{project}}/{{region}}/{{name}} * $ pulumi import gcp:compute/regionHealthAggregationPolicy:RegionHealthAggregationPolicy default {{region}}/{{name}} * $ pulumi import gcp:compute/regionHealthAggregationPolicy:RegionHealthAggregationPolicy default {{name}} * ``` */ export declare class RegionHealthAggregationPolicy extends pulumi.CustomResource { /** * Get an existing RegionHealthAggregationPolicy 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, state?: RegionHealthAggregationPolicyState, opts?: pulumi.CustomResourceOptions): RegionHealthAggregationPolicy; /** * Returns true if the given object is an instance of RegionHealthAggregationPolicy. 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 RegionHealthAggregationPolicy; /** * Creation timestamp in RFC3339 text format. */ readonly creationTimestamp: pulumi.Output; /** * 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; /** * An optional description of this resource. Provide this property when you * create the resource. */ readonly description: pulumi.Output; /** * Fingerprint of this resource. A hash of the contents stored in this object. * This field is used in optimistic locking. This field will be ignored when * inserting a `HealthAggregationPolicy`. An up-to-date fingerprint * must be provided in order to patch the RegionHealthAggregationPolicy; Otherwise, * the request will fail with error `412 conditionNotMet`. To see * the latest fingerprint, make a `get()` request to retrieve the * RegionHealthAggregationPolicy. */ readonly fingerprint: pulumi.Output; /** * Can only be set if the `policyType` field is * `BACKEND_SERVICE_POLICY`. Specifies the threshold (as a * percentage) of healthy endpoints required in order to consider the * aggregated health result HEALTHY. Defaults to `60`. Must be in * range [0, 100]. Not applicable if the `policyType` field is * `DNB_PUBLIC_IP_POLICY`. Can be mutated. This field is optional, * and will be set to the default if unspecified. Note that both this * threshold and `minHealthyThreshold` must be satisfied in order * for HEALTHY to be the aggregated result. "Endpoints" refers to network * endpoints within a Network Endpoint Group or instances within an Instance * Group. */ readonly healthyPercentThreshold: pulumi.Output; /** * Can only be set if the `policyType` field is * `BACKEND_SERVICE_POLICY`. Specifies the minimum number of * healthy endpoints required in order to consider the aggregated health * result HEALTHY. Defaults to `1`. Must be positive. Not * applicable if the `policyType` field is * `DNB_PUBLIC_IP_POLICY`. Can be mutated. This field is optional, * and will be set to the default if unspecified. Note that both this * threshold and `healthyPercentThreshold` must be satisfied in * order for HEALTHY to be the aggregated result. "Endpoints" refers to * network endpoints within a Network Endpoint Group or instances within an * Instance Group. */ readonly minHealthyThreshold: pulumi.Output; /** * 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; /** * Specifies the type of the healthAggregationPolicy. The only allowed value * for global resources is `DNS_PUBLIC_IP_POLICY`. The only allowed * value for regional resources is `BACKEND_SERVICE_POLICY`. Must * be specified when the healthAggregationPolicy is created, and cannot be * mutated. * Default value is `BACKEND_SERVICE_POLICY`. * Possible values are: `DNS_PUBLIC_IP_POLICY`, `BACKEND_SERVICE_POLICY`. */ readonly policyType: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * URL of the region where the health aggregation policy resides. */ readonly region: pulumi.Output; /** * Server-defined URL with id for the resource. */ readonly selfLinkWithId: pulumi.Output; /** * Create a RegionHealthAggregationPolicy 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: RegionHealthAggregationPolicyArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering RegionHealthAggregationPolicy resources. */ export interface RegionHealthAggregationPolicyState { /** * Creation timestamp in RFC3339 text format. */ creationTimestamp?: pulumi.Input; /** * 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; /** * An optional description of this resource. Provide this property when you * create the resource. */ description?: pulumi.Input; /** * Fingerprint of this resource. A hash of the contents stored in this object. * This field is used in optimistic locking. This field will be ignored when * inserting a `HealthAggregationPolicy`. An up-to-date fingerprint * must be provided in order to patch the RegionHealthAggregationPolicy; Otherwise, * the request will fail with error `412 conditionNotMet`. To see * the latest fingerprint, make a `get()` request to retrieve the * RegionHealthAggregationPolicy. */ fingerprint?: pulumi.Input; /** * Can only be set if the `policyType` field is * `BACKEND_SERVICE_POLICY`. Specifies the threshold (as a * percentage) of healthy endpoints required in order to consider the * aggregated health result HEALTHY. Defaults to `60`. Must be in * range [0, 100]. Not applicable if the `policyType` field is * `DNB_PUBLIC_IP_POLICY`. Can be mutated. This field is optional, * and will be set to the default if unspecified. Note that both this * threshold and `minHealthyThreshold` must be satisfied in order * for HEALTHY to be the aggregated result. "Endpoints" refers to network * endpoints within a Network Endpoint Group or instances within an Instance * Group. */ healthyPercentThreshold?: pulumi.Input; /** * Can only be set if the `policyType` field is * `BACKEND_SERVICE_POLICY`. Specifies the minimum number of * healthy endpoints required in order to consider the aggregated health * result HEALTHY. Defaults to `1`. Must be positive. Not * applicable if the `policyType` field is * `DNB_PUBLIC_IP_POLICY`. Can be mutated. This field is optional, * and will be set to the default if unspecified. Note that both this * threshold and `healthyPercentThreshold` must be satisfied in * order for HEALTHY to be the aggregated result. "Endpoints" refers to * network endpoints within a Network Endpoint Group or instances within an * Instance Group. */ minHealthyThreshold?: pulumi.Input; /** * 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; /** * Specifies the type of the healthAggregationPolicy. The only allowed value * for global resources is `DNS_PUBLIC_IP_POLICY`. The only allowed * value for regional resources is `BACKEND_SERVICE_POLICY`. Must * be specified when the healthAggregationPolicy is created, and cannot be * mutated. * Default value is `BACKEND_SERVICE_POLICY`. * Possible values are: `DNS_PUBLIC_IP_POLICY`, `BACKEND_SERVICE_POLICY`. */ policyType?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * URL of the region where the health aggregation policy resides. */ region?: pulumi.Input; /** * Server-defined URL with id for the resource. */ selfLinkWithId?: pulumi.Input; } /** * The set of arguments for constructing a RegionHealthAggregationPolicy resource. */ export interface RegionHealthAggregationPolicyArgs { /** * 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; /** * An optional description of this resource. Provide this property when you * create the resource. */ description?: pulumi.Input; /** * Can only be set if the `policyType` field is * `BACKEND_SERVICE_POLICY`. Specifies the threshold (as a * percentage) of healthy endpoints required in order to consider the * aggregated health result HEALTHY. Defaults to `60`. Must be in * range [0, 100]. Not applicable if the `policyType` field is * `DNB_PUBLIC_IP_POLICY`. Can be mutated. This field is optional, * and will be set to the default if unspecified. Note that both this * threshold and `minHealthyThreshold` must be satisfied in order * for HEALTHY to be the aggregated result. "Endpoints" refers to network * endpoints within a Network Endpoint Group or instances within an Instance * Group. */ healthyPercentThreshold?: pulumi.Input; /** * Can only be set if the `policyType` field is * `BACKEND_SERVICE_POLICY`. Specifies the minimum number of * healthy endpoints required in order to consider the aggregated health * result HEALTHY. Defaults to `1`. Must be positive. Not * applicable if the `policyType` field is * `DNB_PUBLIC_IP_POLICY`. Can be mutated. This field is optional, * and will be set to the default if unspecified. Note that both this * threshold and `healthyPercentThreshold` must be satisfied in * order for HEALTHY to be the aggregated result. "Endpoints" refers to * network endpoints within a Network Endpoint Group or instances within an * Instance Group. */ minHealthyThreshold?: pulumi.Input; /** * 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; /** * Specifies the type of the healthAggregationPolicy. The only allowed value * for global resources is `DNS_PUBLIC_IP_POLICY`. The only allowed * value for regional resources is `BACKEND_SERVICE_POLICY`. Must * be specified when the healthAggregationPolicy is created, and cannot be * mutated. * Default value is `BACKEND_SERVICE_POLICY`. * Possible values are: `DNS_PUBLIC_IP_POLICY`, `BACKEND_SERVICE_POLICY`. */ policyType?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * URL of the region where the health aggregation policy resides. */ region: pulumi.Input; } //# sourceMappingURL=regionHealthAggregationPolicy.d.ts.map