1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. compute
  5. RegionHealthSource
Google Cloud v9.10.0 published on Friday, Jan 16, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

gcp.compute.RegionHealthSource

gcp logo
Google Cloud v9.10.0 published on Friday, Jan 16, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

    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:

    Example Usage

    Compute Region Health Source Basic

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

hap = gcp.compute.RegionHealthAggregationPolicy("hap",
    name="test-health-source-hap",
    description="health aggregation policy for health source",
    region="us-central1")
default = gcp.compute.HealthCheck("default",
    name="test-health-source-hc",
    http_health_check={
        "port": 80,
    })
default_region_backend_service = gcp.compute.RegionBackendService("default",
    name="test-health-source-bs",
    region="us-central1",
    health_checks=default.id,
    load_balancing_scheme="INTERNAL")
example_test_health_source = gcp.compute.RegionHealthSource("example_test_health_source",
    name="test-health-source",
    description="Example health source basic",
    region="us-central1",
    source_type="BACKEND_SERVICE",
    sources=default_region_backend_service.id,
    health_aggregation_policy=hap.id)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		hap, err := compute.NewRegionHealthAggregationPolicy(ctx, "hap", &compute.RegionHealthAggregationPolicyArgs{
			Name:        pulumi.String("test-health-source-hap"),
			Description: pulumi.String("health aggregation policy for health source"),
			Region:      pulumi.String("us-central1"),
		})
		if err != nil {
			return err
		}
		_default, err := compute.NewHealthCheck(ctx, "default", &compute.HealthCheckArgs{
			Name: pulumi.String("test-health-source-hc"),
			HttpHealthCheck: &compute.HealthCheckHttpHealthCheckArgs{
				Port: pulumi.Int(80),
			},
		})
		if err != nil {
			return err
		}
		defaultRegionBackendService, err := compute.NewRegionBackendService(ctx, "default", &compute.RegionBackendServiceArgs{
			Name:                pulumi.String("test-health-source-bs"),
			Region:              pulumi.String("us-central1"),
			HealthChecks:        _default.ID(),
			LoadBalancingScheme: pulumi.String("INTERNAL"),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewRegionHealthSource(ctx, "example_test_health_source", &compute.RegionHealthSourceArgs{
			Name:                    pulumi.String("test-health-source"),
			Description:             pulumi.String("Example health source basic"),
			Region:                  pulumi.String("us-central1"),
			SourceType:              pulumi.String("BACKEND_SERVICE"),
			Sources:                 defaultRegionBackendService.ID(),
			HealthAggregationPolicy: hap.ID(),
		})
		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 hap = new Gcp.Compute.RegionHealthAggregationPolicy("hap", new()
    {
        Name = "test-health-source-hap",
        Description = "health aggregation policy for health source",
        Region = "us-central1",
    });

    var @default = new Gcp.Compute.HealthCheck("default", new()
    {
        Name = "test-health-source-hc",
        HttpHealthCheck = new Gcp.Compute.Inputs.HealthCheckHttpHealthCheckArgs
        {
            Port = 80,
        },
    });

    var defaultRegionBackendService = new Gcp.Compute.RegionBackendService("default", new()
    {
        Name = "test-health-source-bs",
        Region = "us-central1",
        HealthChecks = @default.Id,
        LoadBalancingScheme = "INTERNAL",
    });

    var exampleTestHealthSource = new Gcp.Compute.RegionHealthSource("example_test_health_source", new()
    {
        Name = "test-health-source",
        Description = "Example health source basic",
        Region = "us-central1",
        SourceType = "BACKEND_SERVICE",
        Sources = defaultRegionBackendService.Id,
        HealthAggregationPolicy = hap.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.RegionHealthAggregationPolicy;
import com.pulumi.gcp.compute.RegionHealthAggregationPolicyArgs;
import com.pulumi.gcp.compute.HealthCheck;
import com.pulumi.gcp.compute.HealthCheckArgs;
import com.pulumi.gcp.compute.inputs.HealthCheckHttpHealthCheckArgs;
import com.pulumi.gcp.compute.RegionBackendService;
import com.pulumi.gcp.compute.RegionBackendServiceArgs;
import com.pulumi.gcp.compute.RegionHealthSource;
import com.pulumi.gcp.compute.RegionHealthSourceArgs;
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) {
        var hap = new RegionHealthAggregationPolicy("hap", RegionHealthAggregationPolicyArgs.builder()
            .name("test-health-source-hap")
            .description("health aggregation policy for health source")
            .region("us-central1")
            .build());

        var default_ = new HealthCheck("default", HealthCheckArgs.builder()
            .name("test-health-source-hc")
            .httpHealthCheck(HealthCheckHttpHealthCheckArgs.builder()
                .port(80)
                .build())
            .build());

        var defaultRegionBackendService = new RegionBackendService("defaultRegionBackendService", RegionBackendServiceArgs.builder()
            .name("test-health-source-bs")
            .region("us-central1")
            .healthChecks(default_.id())
            .loadBalancingScheme("INTERNAL")
            .build());

        var exampleTestHealthSource = new RegionHealthSource("exampleTestHealthSource", RegionHealthSourceArgs.builder()
            .name("test-health-source")
            .description("Example health source basic")
            .region("us-central1")
            .sourceType("BACKEND_SERVICE")
            .sources(defaultRegionBackendService.id())
            .healthAggregationPolicy(hap.id())
            .build());

    }
}

    resources:
  hap:
    type: gcp:compute:RegionHealthAggregationPolicy
    properties:
      name: test-health-source-hap
      description: health aggregation policy for health source
      region: us-central1
  default:
    type: gcp:compute:HealthCheck
    properties:
      name: test-health-source-hc
      httpHealthCheck:
        port: 80
  defaultRegionBackendService:
    type: gcp:compute:RegionBackendService
    name: default
    properties:
      name: test-health-source-bs
      region: us-central1
      healthChecks: ${default.id}
      loadBalancingScheme: INTERNAL
  exampleTestHealthSource:
    type: gcp:compute:RegionHealthSource
    name: example_test_health_source
    properties:
      name: test-health-source
      description: Example health source basic
      region: us-central1
      sourceType: BACKEND_SERVICE
      sources: ${defaultRegionBackendService.id}
      healthAggregationPolicy: ${hap.id}

    Create RegionHealthSource Resource

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

    Constructor syntax

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

@overload
def RegionHealthSource(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       region: Optional[str] = None,
                       source_type: Optional[str] = None,
                       description: Optional[str] = None,
                       health_aggregation_policy: Optional[str] = None,
                       name: Optional[str] = None,
                       project: Optional[str] = None,
                       sources: Optional[str] = None)
    func NewRegionHealthSource(ctx *Context, name string, args RegionHealthSourceArgs, opts ...ResourceOption) (*RegionHealthSource, error)
    public RegionHealthSource(string name, RegionHealthSourceArgs args, CustomResourceOptions? opts = null)
    public RegionHealthSource(String name, RegionHealthSourceArgs args)
public RegionHealthSource(String name, RegionHealthSourceArgs args, CustomResourceOptions options)

    type: gcp:compute:RegionHealthSource
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 RegionHealthSourceArgs
    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 RegionHealthSourceArgs
    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 RegionHealthSourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RegionHealthSourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RegionHealthSourceArgs
    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 regionHealthSourceResource = new Gcp.Compute.RegionHealthSource("regionHealthSourceResource", new()
{
    Region = "string",
    SourceType = "string",
    Description = "string",
    HealthAggregationPolicy = "string",
    Name = "string",
    Project = "string",
    Sources = "string",
});

    example, err := compute.NewRegionHealthSource(ctx, "regionHealthSourceResource", &compute.RegionHealthSourceArgs{
	Region:                  pulumi.String("string"),
	SourceType:              pulumi.String("string"),
	Description:             pulumi.String("string"),
	HealthAggregationPolicy: pulumi.String("string"),
	Name:                    pulumi.String("string"),
	Project:                 pulumi.String("string"),
	Sources:                 pulumi.String("string"),
})

    var regionHealthSourceResource = new RegionHealthSource("regionHealthSourceResource", RegionHealthSourceArgs.builder()
    .region("string")
    .sourceType("string")
    .description("string")
    .healthAggregationPolicy("string")
    .name("string")
    .project("string")
    .sources("string")
    .build());

    region_health_source_resource = gcp.compute.RegionHealthSource("regionHealthSourceResource",
    region="string",
    source_type="string",
    description="string",
    health_aggregation_policy="string",
    name="string",
    project="string",
    sources="string")

    const regionHealthSourceResource = new gcp.compute.RegionHealthSource("regionHealthSourceResource", {
    region: "string",
    sourceType: "string",
    description: "string",
    healthAggregationPolicy: "string",
    name: "string",
    project: "string",
    sources: "string",
});

    type: gcp:compute:RegionHealthSource
properties:
    description: string
    healthAggregationPolicy: string
    name: string
    project: string
    region: string
    sourceType: string
    sources: string

    RegionHealthSource 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 RegionHealthSource resource accepts the following input properties:

    Region string
    URL of the region where the health source resides.
    SourceType 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.
    Description string
    An optional description of this resource. Provide this property when you create the resource.
    HealthAggregationPolicy string
    URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.
    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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Sources 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.
    Region string
    URL of the region where the health source resides.
    SourceType 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.
    Description string
    An optional description of this resource. Provide this property when you create the resource.
    HealthAggregationPolicy string
    URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.
    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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Sources 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.
    region String
    URL of the region where the health source resides.
    sourceType 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.
    description String
    An optional description of this resource. Provide this property when you create the resource.
    healthAggregationPolicy String
    URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.
    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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    sources 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.
    region string
    URL of the region where the health source resides.
    sourceType 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.
    description string
    An optional description of this resource. Provide this property when you create the resource.
    healthAggregationPolicy string
    URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.
    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.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    sources 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.
    region str
    URL of the region where the health source resides.
    source_type str
    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.
    description str
    An optional description of this resource. Provide this property when you create the resource.
    health_aggregation_policy str
    URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.
    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.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    sources str
    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.
    region String
    URL of the region where the health source resides.
    sourceType 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.
    description String
    An optional description of this resource. Provide this property when you create the resource.
    healthAggregationPolicy String
    URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.
    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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    sources 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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RegionHealthSource 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.
    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.
    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.
    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.
    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.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    selfLinkWithId String
    Server-defined URL with id for the resource.

    Look up Existing RegionHealthSource Resource

    Get an existing RegionHealthSource 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?: RegionHealthSourceState, opts?: CustomResourceOptions): RegionHealthSource
    @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,
        health_aggregation_policy: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        region: Optional[str] = None,
        self_link_with_id: Optional[str] = None,
        source_type: Optional[str] = None,
        sources: Optional[str] = None) -> RegionHealthSource
    func GetRegionHealthSource(ctx *Context, name string, id IDInput, state *RegionHealthSourceState, opts ...ResourceOption) (*RegionHealthSource, error)
    public static RegionHealthSource Get(string name, Input<string> id, RegionHealthSourceState? state, CustomResourceOptions? opts = null)
    public static RegionHealthSource get(String name, Output<String> id, RegionHealthSourceState state, CustomResourceOptions options)
    resources:  _:    type: gcp:compute:RegionHealthSource    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.
    HealthAggregationPolicy string
    URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.
    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.
    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 source resides.
    SelfLinkWithId string
    Server-defined URL with id for the resource.
    SourceType 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.
    Sources 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.
    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.
    HealthAggregationPolicy string
    URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.
    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.
    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 source resides.
    SelfLinkWithId string
    Server-defined URL with id for the resource.
    SourceType 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.
    Sources 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.
    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.
    healthAggregationPolicy String
    URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.
    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.
    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 source resides.
    selfLinkWithId String
    Server-defined URL with id for the resource.
    sourceType 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.
    sources 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.
    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.
    healthAggregationPolicy string
    URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.
    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.
    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 source resides.
    selfLinkWithId string
    Server-defined URL with id for the resource.
    sourceType 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.
    sources 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.
    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.
    health_aggregation_policy str
    URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.
    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.
    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 source resides.
    self_link_with_id str
    Server-defined URL with id for the resource.
    source_type str
    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.
    sources str
    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.
    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.
    healthAggregationPolicy String
    URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.
    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.
    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 source resides.
    selfLinkWithId String
    Server-defined URL with id for the resource.
    sourceType 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.
    sources 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.

    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:

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

    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.10.0 published on Friday, Jan 16, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-gcp
      Meet Neo: Your AI Platform Teammate