RegionHealthAggregationPolicy class

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")

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

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

data "gcp_organizations_getproject" "project" {
}

resource "gcp_compute_regionhealthaggregationpolicy" "example_test_health_aggregation_policy" {
  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.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) {
        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: {}

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

Constructors

RegionHealthAggregationPolicy(String name, {RegionHealthAggregationPolicyArgs? args, CustomResourceOptions? options}): Creates a new RegionHealthAggregationPolicy. name The Pulumi resource name. args Arguments used to configure this RegionHealthAggregationPolicy. The set of arguments for RegionHealthAggregationPolicy. options Resource options controlling this resource's behavior.
RegionHealthAggregationPolicy.reference(String urn): Creates a typed reference to an existing RegionHealthAggregationPolicy resource.

Properties

childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
creationTimestamp ↔ Output<String>: Creation timestamp in RFC3339 text format.
latefinal
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.
latefinal
description ↔ Output<String?>: An optional description of this resource. Provide this property when you create the resource.
latefinal
fingerprint ↔ Output<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.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
healthyPercentThreshold ↔ Output<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.
latefinal
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
minHealthyThreshold ↔ Output<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.
latefinal
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.
latefinal
policyType ↔ Output<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.
latefinal
project ↔ Output<String>: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
region ↔ Output<String>: URL of the region where the health aggregation policy resides.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
selfLinkWithId ↔ Output<String>: Server-defined URL with id for the resource.
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited

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, {RegionHealthAggregationPolicyState? state, CustomResourceOptions? options}) → RegionHealthAggregationPolicy: Gets an existing RegionHealthAggregationPolicy resource's state with the given name and id.