1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. compute
  5. RegionHealthAggregationPolicy
Google Cloud v9.6.0 published on Wednesday, Nov 26, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

gcp.compute.RegionHealthAggregationPolicy

gcp logo
Google Cloud v9.6.0 published on Wednesday, Nov 26, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

    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:

    Example Usage

    Compute Region Health Aggregation Policy Basic

    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 pulumi
import pulumi_gcp as gcp

project = gcp.organizations.get_project()
example_test_health_aggregation_policy = gcp.compute.RegionHealthAggregationPolicy("example_test_health_aggregation_policy",
    name="test-health-aggregation-policy",
    description="Example health aggregation policy basic",
    region="us-central1")

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/organizations"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := organizations.LookupProject(ctx, &organizations.LookupProjectArgs{}, nil)
		if err != nil {
			return err
		}
		_, err = compute.NewRegionHealthAggregationPolicy(ctx, "example_test_health_aggregation_policy", &compute.RegionHealthAggregationPolicyArgs{
			Name:        pulumi.String("test-health-aggregation-policy"),
			Description: pulumi.String("Example health aggregation policy basic"),
			Region:      pulumi.String("us-central1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var project = Gcp.Organizations.GetProject.Invoke();

    var exampleTestHealthAggregationPolicy = new Gcp.Compute.RegionHealthAggregationPolicy("example_test_health_aggregation_policy", new()
    {
        Name = "test-health-aggregation-policy",
        Description = "Example health aggregation policy basic",
        Region = "us-central1",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import com.pulumi.gcp.compute.RegionHealthAggregationPolicy;
import com.pulumi.gcp.compute.RegionHealthAggregationPolicyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var project = OrganizationsFunctions.getProject(GetProjectArgs.builder()
            .build());

        var exampleTestHealthAggregationPolicy = new RegionHealthAggregationPolicy("exampleTestHealthAggregationPolicy", RegionHealthAggregationPolicyArgs.builder()
            .name("test-health-aggregation-policy")
            .description("Example health aggregation policy basic")
            .region("us-central1")
            .build());

    }
}

    resources:
  exampleTestHealthAggregationPolicy:
    type: gcp:compute:RegionHealthAggregationPolicy
    name: example_test_health_aggregation_policy
    properties:
      name: test-health-aggregation-policy
      description: Example health aggregation policy basic
      region: us-central1
variables:
  project:
    fn::invoke:
      function: gcp:organizations:getProject
      arguments: {}

    Create RegionHealthAggregationPolicy Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RegionHealthAggregationPolicy(name: string, args: RegionHealthAggregationPolicyArgs, opts?: CustomResourceOptions);
    @overload
def RegionHealthAggregationPolicy(resource_name: str,
                                  args: RegionHealthAggregationPolicyArgs,
                                  opts: Optional[ResourceOptions] = None)

@overload
def RegionHealthAggregationPolicy(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  region: Optional[str] = None,
                                  description: Optional[str] = None,
                                  healthy_percent_threshold: Optional[int] = None,
                                  min_healthy_threshold: Optional[int] = None,
                                  name: Optional[str] = None,
                                  policy_type: Optional[str] = None,
                                  project: Optional[str] = None)
    func NewRegionHealthAggregationPolicy(ctx *Context, name string, args RegionHealthAggregationPolicyArgs, opts ...ResourceOption) (*RegionHealthAggregationPolicy, error)
    public RegionHealthAggregationPolicy(string name, RegionHealthAggregationPolicyArgs args, CustomResourceOptions? opts = null)
    public RegionHealthAggregationPolicy(String name, RegionHealthAggregationPolicyArgs args)
public RegionHealthAggregationPolicy(String name, RegionHealthAggregationPolicyArgs args, CustomResourceOptions options)

    type: gcp:compute:RegionHealthAggregationPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args RegionHealthAggregationPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RegionHealthAggregationPolicyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RegionHealthAggregationPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RegionHealthAggregationPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RegionHealthAggregationPolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var regionHealthAggregationPolicyResource = new Gcp.Compute.RegionHealthAggregationPolicy("regionHealthAggregationPolicyResource", new()
{
    Region = "string",
    Description = "string",
    HealthyPercentThreshold = 0,
    MinHealthyThreshold = 0,
    Name = "string",
    PolicyType = "string",
    Project = "string",
});

    example, err := compute.NewRegionHealthAggregationPolicy(ctx, "regionHealthAggregationPolicyResource", &compute.RegionHealthAggregationPolicyArgs{
	Region:                  pulumi.String("string"),
	Description:             pulumi.String("string"),
	HealthyPercentThreshold: pulumi.Int(0),
	MinHealthyThreshold:     pulumi.Int(0),
	Name:                    pulumi.String("string"),
	PolicyType:              pulumi.String("string"),
	Project:                 pulumi.String("string"),
})

    var regionHealthAggregationPolicyResource = new RegionHealthAggregationPolicy("regionHealthAggregationPolicyResource", RegionHealthAggregationPolicyArgs.builder()
    .region("string")
    .description("string")
    .healthyPercentThreshold(0)
    .minHealthyThreshold(0)
    .name("string")
    .policyType("string")
    .project("string")
    .build());

    region_health_aggregation_policy_resource = gcp.compute.RegionHealthAggregationPolicy("regionHealthAggregationPolicyResource",
    region="string",
    description="string",
    healthy_percent_threshold=0,
    min_healthy_threshold=0,
    name="string",
    policy_type="string",
    project="string")

    const regionHealthAggregationPolicyResource = new gcp.compute.RegionHealthAggregationPolicy("regionHealthAggregationPolicyResource", {
    region: "string",
    description: "string",
    healthyPercentThreshold: 0,
    minHealthyThreshold: 0,
    name: "string",
    policyType: "string",
    project: "string",
});

    type: gcp:compute:RegionHealthAggregationPolicy
properties:
    description: string
    healthyPercentThreshold: 0
    minHealthyThreshold: 0
    name: string
    policyType: string
    project: string
    region: string

    RegionHealthAggregationPolicy Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The RegionHealthAggregationPolicy resource accepts the following input properties:

    Region string
    URL of the region where the health aggregation policy resides.
    Description string
    An optional description of this resource. Provide this property when you create the resource.
    HealthyPercentThreshold int
    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.
    MinHealthyThreshold int
    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.
    Name 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.
    PolicyType string
    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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Region string
    URL of the region where the health aggregation policy resides.
    Description string
    An optional description of this resource. Provide this property when you create the resource.
    HealthyPercentThreshold int
    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.
    MinHealthyThreshold int
    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.
    Name 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.
    PolicyType string
    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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region String
    URL of the region where the health aggregation policy resides.
    description String
    An optional description of this resource. Provide this property when you create the resource.
    healthyPercentThreshold Integer
    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.
    minHealthyThreshold Integer
    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.
    name 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.
    policyType String
    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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region string
    URL of the region where the health aggregation policy resides.
    description string
    An optional description of this resource. Provide this property when you create the resource.
    healthyPercentThreshold number
    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.
    minHealthyThreshold number
    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.
    name 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.
    policyType string
    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.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region str
    URL of the region where the health aggregation policy resides.
    description str
    An optional description of this resource. Provide this property when you create the resource.
    healthy_percent_threshold int
    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.
    min_healthy_threshold int
    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.
    name str
    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.
    policy_type str
    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.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region String
    URL of the region where the health aggregation policy resides.
    description String
    An optional description of this resource. Provide this property when you create the resource.
    healthyPercentThreshold Number
    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.
    minHealthyThreshold Number
    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.
    name 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.
    policyType String
    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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RegionHealthAggregationPolicy resource produces the following output properties:

    CreationTimestamp string
    Creation timestamp in RFC3339 text format.
    Fingerprint string
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    SelfLinkWithId string
    Server-defined URL with id for the resource.
    CreationTimestamp string
    Creation timestamp in RFC3339 text format.
    Fingerprint string
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    SelfLinkWithId string
    Server-defined URL with id for the resource.
    creationTimestamp String
    Creation timestamp in RFC3339 text format.
    fingerprint String
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    selfLinkWithId String
    Server-defined URL with id for the resource.
    creationTimestamp string
    Creation timestamp in RFC3339 text format.
    fingerprint string
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    selfLinkWithId string
    Server-defined URL with id for the resource.
    creation_timestamp str
    Creation timestamp in RFC3339 text format.
    fingerprint str
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    self_link_with_id str
    Server-defined URL with id for the resource.
    creationTimestamp String
    Creation timestamp in RFC3339 text format.
    fingerprint String
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    selfLinkWithId String
    Server-defined URL with id for the resource.

    Look up Existing RegionHealthAggregationPolicy Resource

    Get an existing RegionHealthAggregationPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: RegionHealthAggregationPolicyState, opts?: CustomResourceOptions): RegionHealthAggregationPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        creation_timestamp: Optional[str] = None,
        description: Optional[str] = None,
        fingerprint: Optional[str] = None,
        healthy_percent_threshold: Optional[int] = None,
        min_healthy_threshold: Optional[int] = None,
        name: Optional[str] = None,
        policy_type: Optional[str] = None,
        project: Optional[str] = None,
        region: Optional[str] = None,
        self_link_with_id: Optional[str] = None) -> RegionHealthAggregationPolicy
    func GetRegionHealthAggregationPolicy(ctx *Context, name string, id IDInput, state *RegionHealthAggregationPolicyState, opts ...ResourceOption) (*RegionHealthAggregationPolicy, error)
    public static RegionHealthAggregationPolicy Get(string name, Input<string> id, RegionHealthAggregationPolicyState? state, CustomResourceOptions? opts = null)
    public static RegionHealthAggregationPolicy get(String name, Output<String> id, RegionHealthAggregationPolicyState state, CustomResourceOptions options)
    resources:  _:    type: gcp:compute:RegionHealthAggregationPolicy    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreationTimestamp string
    Creation timestamp in RFC3339 text format.
    Description string
    An optional description of this resource. Provide this property when you create the resource.
    Fingerprint string
    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.
    HealthyPercentThreshold int
    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.
    MinHealthyThreshold int
    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.
    Name 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.
    PolicyType string
    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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Region string
    URL of the region where the health aggregation policy resides.
    SelfLinkWithId string
    Server-defined URL with id for the resource.
    CreationTimestamp string
    Creation timestamp in RFC3339 text format.
    Description string
    An optional description of this resource. Provide this property when you create the resource.
    Fingerprint string
    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.
    HealthyPercentThreshold int
    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.
    MinHealthyThreshold int
    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.
    Name 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.
    PolicyType string
    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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Region string
    URL of the region where the health aggregation policy resides.
    SelfLinkWithId string
    Server-defined URL with id for the resource.
    creationTimestamp String
    Creation timestamp in RFC3339 text format.
    description String
    An optional description of this resource. Provide this property when you create the resource.
    fingerprint String
    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.
    healthyPercentThreshold Integer
    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.
    minHealthyThreshold Integer
    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.
    name 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.
    policyType String
    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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region String
    URL of the region where the health aggregation policy resides.
    selfLinkWithId String
    Server-defined URL with id for the resource.
    creationTimestamp string
    Creation timestamp in RFC3339 text format.
    description string
    An optional description of this resource. Provide this property when you create the resource.
    fingerprint string
    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.
    healthyPercentThreshold number
    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.
    minHealthyThreshold number
    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.
    name 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.
    policyType string
    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.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region string
    URL of the region where the health aggregation policy resides.
    selfLinkWithId string
    Server-defined URL with id for the resource.
    creation_timestamp str
    Creation timestamp in RFC3339 text format.
    description str
    An optional description of this resource. Provide this property when you create the resource.
    fingerprint str
    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.
    healthy_percent_threshold int
    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.
    min_healthy_threshold int
    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.
    name str
    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.
    policy_type str
    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.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region str
    URL of the region where the health aggregation policy resides.
    self_link_with_id str
    Server-defined URL with id for the resource.
    creationTimestamp String
    Creation timestamp in RFC3339 text format.
    description String
    An optional description of this resource. Provide this property when you create the resource.
    fingerprint String
    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.
    healthyPercentThreshold Number
    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.
    minHealthyThreshold Number
    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.
    name 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.
    policyType String
    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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region String
    URL of the region where the health aggregation policy resides.
    selfLinkWithId String
    Server-defined URL with id for the resource.

    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:

    $ 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}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud v9.6.0 published on Wednesday, Nov 26, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-gcp
      Meet Neo: Your AI Platform Teammate