RegionHealthSource class

A health source resource specifies the source resources and the health aggregation policy applied to the source resources to determine the aggregated health status.

To get more information about RegionHealthSource, see:

• API documentation
• How-to Guides
• Health checks overview

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)

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 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().ToIDOutput().ToStringOutput(),
			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().ToIDOutput().ToStringOutput(),
			HealthAggregationPolicy: hap.ID().ToIDOutput().ToStringOutput(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_compute_regionhealthaggregationpolicy" "hap" {
  name        = "test-health-source-hap"
  description = "health aggregation policy for health source"
  region      = "us-central1"
}
resource "gcp_compute_healthcheck" "default" {
  name = "test-health-source-hc"
  http_health_check = {
    port = 80
  }
}
resource "gcp_compute_regionbackendservice" "default" {
  name                  = "test-health-source-bs"
  region                = "us-central1"
  health_checks         = gcp_compute_healthcheck.default.id
  load_balancing_scheme = "INTERNAL"
}
resource "gcp_compute_regionhealthsource" "example_test_health_source" {
  name                      = "test-health-source"
  description               = "Example health source basic"
  region                    = "us-central1"
  source_type               = "BACKEND_SERVICE"
  sources                   = gcp_compute_regionbackendservice.default.id
  health_aggregation_policy = gcp_compute_regionhealthaggregationpolicy.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.ArrayList;
import java.util.Arrays;
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}

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

Constructors

RegionHealthSource(String name, {RegionHealthSourceArgs? args, CustomResourceOptions? options})

Creates a new RegionHealthSource. name The Pulumi resource name. args Arguments used to configure this RegionHealthSource. The set of arguments for RegionHealthSource. options Resource options controlling this resource's behavior.

RegionHealthSource.reference(String urn)

Creates a typed reference to an existing RegionHealthSource resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

creationTimestamp ↔ Output<String>

Creation timestamp in RFC3339 text format.

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

description ↔ Output<String?>

An optional description of this resource. Provide this property when you create the resource.

late, final

fingerprint ↔ Output<String>

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

healthAggregationPolicy ↔ Output<String?>

URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.

late, final

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

name ↔ Output<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.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

region ↔ Output<String>

URL of the region where the health source resides.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

selfLinkWithId ↔ Output<String>

Server-defined URL with id for the resource.

late, final

sources ↔ Output<String?>

URLs to the source resources. Must be size 1. Must be a BackendService if the sourceType is BACKEND_SERVICE. The BackendService must have load balancing scheme INTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the HealthSource (cross-region deployment for INTERNAL_MANAGED is not supported). The BackendService may use only IGs, MIGs, or NEGs of type GCE_VM_IP or GCE_VM_IP_PORT. The BackendService may not use haPolicy. Can be mutated.

late, final

sourceType ↔ Output<String>

Specifies the type of the HealthSource. The only allowed value is BACKEND_SERVICE. Must be specified when the HealthSource is created, and cannot be mutated. Possible values are: BACKEND_SERVICE.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {RegionHealthSourceState? state, CustomResourceOptions? options}) → RegionHealthSource

Gets an existing RegionHealthSource resource's state with the given name and id.