@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
524 lines • 20 kB
JavaScript
"use strict";
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.RegionBackendService = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* A Region Backend Service defines a regionally-scoped group of virtual
* machines that will serve traffic for load balancing.
*
* To get more information about RegionBackendService, see:
*
* * [API documentation](https://cloud.google.com/compute/docs/reference/latest/regionBackendServices)
* * How-to Guides
* * [Internal TCP/UDP Load Balancing](https://cloud.google.com/compute/docs/load-balancing/internal/)
*
* ## Example Usage
*
* ### Region Backend Service Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const defaultHealthCheck = new gcp.compute.HealthCheck("default", {
* name: "rbs-health-check",
* checkIntervalSec: 1,
* timeoutSec: 1,
* tcpHealthCheck: {
* port: 80,
* },
* });
* const _default = new gcp.compute.RegionBackendService("default", {
* name: "region-service",
* region: "us-central1",
* healthChecks: defaultHealthCheck.id,
* connectionDrainingTimeoutSec: 10,
* sessionAffinity: "CLIENT_IP",
* });
* ```
* ### Region Backend Service External Iap
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.compute.RegionBackendService("default", {
* name: "tf-test-region-service-external",
* region: "us-central1",
* protocol: "HTTP",
* loadBalancingScheme: "EXTERNAL",
* iap: {
* enabled: true,
* oauth2ClientId: "abc",
* oauth2ClientSecret: "xyz",
* },
* });
* ```
* ### Region Backend Service Cache
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const defaultRegionHealthCheck = new gcp.compute.RegionHealthCheck("default", {
* name: "rbs-health-check",
* region: "us-central1",
* httpHealthCheck: {
* port: 80,
* },
* });
* const _default = new gcp.compute.RegionBackendService("default", {
* name: "region-service",
* region: "us-central1",
* healthChecks: defaultRegionHealthCheck.id,
* enableCdn: true,
* cdnPolicy: {
* cacheMode: "CACHE_ALL_STATIC",
* defaultTtl: 3600,
* clientTtl: 7200,
* maxTtl: 10800,
* negativeCaching: true,
* signedUrlCacheMaxAgeSec: 7200,
* },
* loadBalancingScheme: "EXTERNAL",
* protocol: "HTTP",
* });
* ```
* ### Region Backend Service Ilb Round Robin
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const healthCheck = new gcp.compute.HealthCheck("health_check", {
* name: "rbs-health-check",
* httpHealthCheck: {
* port: 80,
* },
* });
* const _default = new gcp.compute.RegionBackendService("default", {
* region: "us-central1",
* name: "region-service",
* healthChecks: healthCheck.id,
* protocol: "HTTP",
* loadBalancingScheme: "INTERNAL_MANAGED",
* localityLbPolicy: "ROUND_ROBIN",
* });
* ```
* ### Region Backend Service External
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const healthCheck = new gcp.compute.RegionHealthCheck("health_check", {
* name: "rbs-health-check",
* region: "us-central1",
* tcpHealthCheck: {
* port: 80,
* },
* });
* const _default = new gcp.compute.RegionBackendService("default", {
* region: "us-central1",
* name: "region-service",
* healthChecks: healthCheck.id,
* protocol: "TCP",
* loadBalancingScheme: "EXTERNAL",
* });
* ```
* ### Region Backend Service External Weighted
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const healthCheck = new gcp.compute.RegionHealthCheck("health_check", {
* name: "rbs-health-check",
* region: "us-central1",
* httpHealthCheck: {
* port: 80,
* },
* });
* const _default = new gcp.compute.RegionBackendService("default", {
* region: "us-central1",
* name: "region-service",
* healthChecks: healthCheck.id,
* protocol: "TCP",
* loadBalancingScheme: "EXTERNAL",
* localityLbPolicy: "WEIGHTED_MAGLEV",
* });
* ```
* ### Region Backend Service Ilb Ring Hash
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const healthCheck = new gcp.compute.HealthCheck("health_check", {
* name: "rbs-health-check",
* httpHealthCheck: {
* port: 80,
* },
* });
* const _default = new gcp.compute.RegionBackendService("default", {
* region: "us-central1",
* name: "region-service",
* healthChecks: healthCheck.id,
* loadBalancingScheme: "INTERNAL_MANAGED",
* localityLbPolicy: "RING_HASH",
* sessionAffinity: "HTTP_COOKIE",
* protocol: "HTTP",
* circuitBreakers: {
* maxConnections: 10,
* },
* consistentHash: {
* httpCookie: {
* ttl: {
* seconds: 11,
* nanos: 1111,
* },
* name: "mycookie",
* },
* },
* outlierDetection: {
* consecutiveErrors: 2,
* },
* });
* ```
* ### Region Backend Service Ilb Stateful Session Affinity
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const healthCheck = new gcp.compute.HealthCheck("health_check", {
* name: "rbs-health-check",
* httpHealthCheck: {
* port: 80,
* },
* });
* const _default = new gcp.compute.RegionBackendService("default", {
* region: "us-central1",
* name: "region-service",
* healthChecks: healthCheck.id,
* loadBalancingScheme: "INTERNAL_MANAGED",
* localityLbPolicy: "RING_HASH",
* sessionAffinity: "STRONG_COOKIE_AFFINITY",
* protocol: "HTTP",
* strongSessionAffinityCookie: {
* ttl: {
* seconds: 11,
* nanos: 1111,
* },
* name: "mycookie",
* },
* });
* ```
* ### Region Backend Service Balancing Mode
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const debianImage = gcp.compute.getImage({
* family: "debian-11",
* project: "debian-cloud",
* });
* const defaultNetwork = new gcp.compute.Network("default", {
* name: "rbs-net",
* autoCreateSubnetworks: false,
* routingMode: "REGIONAL",
* });
* const defaultSubnetwork = new gcp.compute.Subnetwork("default", {
* name: "rbs-net-default",
* ipCidrRange: "10.1.2.0/24",
* region: "us-central1",
* network: defaultNetwork.id,
* });
* const instanceTemplate = new gcp.compute.InstanceTemplate("instance_template", {
* name: "template-region-service",
* machineType: "e2-medium",
* networkInterfaces: [{
* network: defaultNetwork.id,
* subnetwork: defaultSubnetwork.id,
* }],
* disks: [{
* sourceImage: debianImage.then(debianImage => debianImage.selfLink),
* autoDelete: true,
* boot: true,
* }],
* tags: [
* "allow-ssh",
* "load-balanced-backend",
* ],
* });
* const rigm = new gcp.compute.RegionInstanceGroupManager("rigm", {
* region: "us-central1",
* name: "rbs-rigm",
* versions: [{
* instanceTemplate: instanceTemplate.id,
* name: "primary",
* }],
* baseInstanceName: "internal-glb",
* targetSize: 1,
* });
* const defaultRegionHealthCheck = new gcp.compute.RegionHealthCheck("default", {
* region: "us-central1",
* name: "rbs-health-check",
* httpHealthCheck: {
* portSpecification: "USE_SERVING_PORT",
* },
* });
* const _default = new gcp.compute.RegionBackendService("default", {
* loadBalancingScheme: "INTERNAL_MANAGED",
* backends: [{
* group: rigm.instanceGroup,
* balancingMode: "UTILIZATION",
* capacityScaler: 1,
* }],
* region: "us-central1",
* name: "region-service",
* protocol: "HTTP",
* timeoutSec: 10,
* healthChecks: defaultRegionHealthCheck.id,
* });
* ```
* ### Region Backend Service Connection Tracking
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const healthCheck = new gcp.compute.RegionHealthCheck("health_check", {
* name: "rbs-health-check",
* region: "us-central1",
* tcpHealthCheck: {
* port: 22,
* },
* });
* const _default = new gcp.compute.RegionBackendService("default", {
* name: "region-service",
* region: "us-central1",
* healthChecks: healthCheck.id,
* connectionDrainingTimeoutSec: 10,
* sessionAffinity: "CLIENT_IP",
* protocol: "TCP",
* loadBalancingScheme: "EXTERNAL",
* connectionTrackingPolicy: {
* trackingMode: "PER_SESSION",
* connectionPersistenceOnUnhealthyBackends: "NEVER_PERSIST",
* idleTimeoutSec: 60,
* enableStrongAffinity: true,
* },
* });
* ```
* ### Region Backend Service Ip Address Selection Policy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const healthCheck = new gcp.compute.RegionHealthCheck("health_check", {
* name: "rbs-health-check",
* region: "us-central1",
* tcpHealthCheck: {
* port: 80,
* },
* });
* const _default = new gcp.compute.RegionBackendService("default", {
* name: "region-service",
* region: "us-central1",
* healthChecks: healthCheck.id,
* loadBalancingScheme: "EXTERNAL_MANAGED",
* protocol: "HTTP",
* ipAddressSelectionPolicy: "IPV6_ONLY",
* });
* ```
* ### Region Backend Service Ilb Custom Metrics
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.compute.Network("default", {name: "network"});
* // Zonal NEG with GCE_VM_IP_PORT
* const defaultNetworkEndpointGroup = new gcp.compute.NetworkEndpointGroup("default", {
* name: "network-endpoint",
* network: _default.id,
* defaultPort: 90,
* zone: "us-central1-a",
* networkEndpointType: "GCE_VM_IP_PORT",
* });
* const healthCheck = new gcp.compute.HealthCheck("health_check", {
* name: "rbs-health-check",
* httpHealthCheck: {
* port: 80,
* },
* });
* const defaultRegionBackendService = new gcp.compute.RegionBackendService("default", {
* region: "us-central1",
* name: "region-service",
* healthChecks: healthCheck.id,
* loadBalancingScheme: "INTERNAL_MANAGED",
* localityLbPolicy: "WEIGHTED_ROUND_ROBIN",
* customMetrics: [{
* name: "orca.application_utilization",
* dryRun: false,
* }],
* backends: [{
* group: defaultNetworkEndpointGroup.id,
* balancingMode: "CUSTOM_METRICS",
* customMetrics: [
* {
* name: "orca.cpu_utilization",
* maxUtilization: 0.9,
* dryRun: true,
* },
* {
* name: "orca.named_metrics.foo",
* dryRun: false,
* },
* ],
* }],
* });
* ```
*
* ## Import
*
* RegionBackendService can be imported using any of these accepted formats:
*
* * `projects/{{project}}/regions/{{region}}/backendServices/{{name}}`
*
* * `{{project}}/{{region}}/{{name}}`
*
* * `{{region}}/{{name}}`
*
* * `{{name}}`
*
* When using the `pulumi import` command, RegionBackendService can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:compute/regionBackendService:RegionBackendService default projects/{{project}}/regions/{{region}}/backendServices/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/regionBackendService:RegionBackendService default {{project}}/{{region}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/regionBackendService:RegionBackendService default {{region}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/regionBackendService:RegionBackendService default {{name}}
* ```
*/
class RegionBackendService extends pulumi.CustomResource {
/**
* Get an existing RegionBackendService resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new RegionBackendService(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of RegionBackendService. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === RegionBackendService.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["affinityCookieTtlSec"] = state ? state.affinityCookieTtlSec : undefined;
resourceInputs["backends"] = state ? state.backends : undefined;
resourceInputs["cdnPolicy"] = state ? state.cdnPolicy : undefined;
resourceInputs["circuitBreakers"] = state ? state.circuitBreakers : undefined;
resourceInputs["connectionDrainingTimeoutSec"] = state ? state.connectionDrainingTimeoutSec : undefined;
resourceInputs["connectionTrackingPolicy"] = state ? state.connectionTrackingPolicy : undefined;
resourceInputs["consistentHash"] = state ? state.consistentHash : undefined;
resourceInputs["creationTimestamp"] = state ? state.creationTimestamp : undefined;
resourceInputs["customMetrics"] = state ? state.customMetrics : undefined;
resourceInputs["description"] = state ? state.description : undefined;
resourceInputs["enableCdn"] = state ? state.enableCdn : undefined;
resourceInputs["failoverPolicy"] = state ? state.failoverPolicy : undefined;
resourceInputs["fingerprint"] = state ? state.fingerprint : undefined;
resourceInputs["generatedId"] = state ? state.generatedId : undefined;
resourceInputs["healthChecks"] = state ? state.healthChecks : undefined;
resourceInputs["iap"] = state ? state.iap : undefined;
resourceInputs["ipAddressSelectionPolicy"] = state ? state.ipAddressSelectionPolicy : undefined;
resourceInputs["loadBalancingScheme"] = state ? state.loadBalancingScheme : undefined;
resourceInputs["localityLbPolicy"] = state ? state.localityLbPolicy : undefined;
resourceInputs["logConfig"] = state ? state.logConfig : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["network"] = state ? state.network : undefined;
resourceInputs["outlierDetection"] = state ? state.outlierDetection : undefined;
resourceInputs["portName"] = state ? state.portName : undefined;
resourceInputs["project"] = state ? state.project : undefined;
resourceInputs["protocol"] = state ? state.protocol : undefined;
resourceInputs["region"] = state ? state.region : undefined;
resourceInputs["securityPolicy"] = state ? state.securityPolicy : undefined;
resourceInputs["selfLink"] = state ? state.selfLink : undefined;
resourceInputs["sessionAffinity"] = state ? state.sessionAffinity : undefined;
resourceInputs["strongSessionAffinityCookie"] = state ? state.strongSessionAffinityCookie : undefined;
resourceInputs["subsetting"] = state ? state.subsetting : undefined;
resourceInputs["timeoutSec"] = state ? state.timeoutSec : undefined;
}
else {
const args = argsOrState;
resourceInputs["affinityCookieTtlSec"] = args ? args.affinityCookieTtlSec : undefined;
resourceInputs["backends"] = args ? args.backends : undefined;
resourceInputs["cdnPolicy"] = args ? args.cdnPolicy : undefined;
resourceInputs["circuitBreakers"] = args ? args.circuitBreakers : undefined;
resourceInputs["connectionDrainingTimeoutSec"] = args ? args.connectionDrainingTimeoutSec : undefined;
resourceInputs["connectionTrackingPolicy"] = args ? args.connectionTrackingPolicy : undefined;
resourceInputs["consistentHash"] = args ? args.consistentHash : undefined;
resourceInputs["customMetrics"] = args ? args.customMetrics : undefined;
resourceInputs["description"] = args ? args.description : undefined;
resourceInputs["enableCdn"] = args ? args.enableCdn : undefined;
resourceInputs["failoverPolicy"] = args ? args.failoverPolicy : undefined;
resourceInputs["healthChecks"] = args ? args.healthChecks : undefined;
resourceInputs["iap"] = args ? args.iap : undefined;
resourceInputs["ipAddressSelectionPolicy"] = args ? args.ipAddressSelectionPolicy : undefined;
resourceInputs["loadBalancingScheme"] = args ? args.loadBalancingScheme : undefined;
resourceInputs["localityLbPolicy"] = args ? args.localityLbPolicy : undefined;
resourceInputs["logConfig"] = args ? args.logConfig : undefined;
resourceInputs["name"] = args ? args.name : undefined;
resourceInputs["network"] = args ? args.network : undefined;
resourceInputs["outlierDetection"] = args ? args.outlierDetection : undefined;
resourceInputs["portName"] = args ? args.portName : undefined;
resourceInputs["project"] = args ? args.project : undefined;
resourceInputs["protocol"] = args ? args.protocol : undefined;
resourceInputs["region"] = args ? args.region : undefined;
resourceInputs["securityPolicy"] = args ? args.securityPolicy : undefined;
resourceInputs["sessionAffinity"] = args ? args.sessionAffinity : undefined;
resourceInputs["strongSessionAffinityCookie"] = args ? args.strongSessionAffinityCookie : undefined;
resourceInputs["subsetting"] = args ? args.subsetting : undefined;
resourceInputs["timeoutSec"] = args ? args.timeoutSec : undefined;
resourceInputs["creationTimestamp"] = undefined /*out*/;
resourceInputs["fingerprint"] = undefined /*out*/;
resourceInputs["generatedId"] = undefined /*out*/;
resourceInputs["selfLink"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(RegionBackendService.__pulumiType, name, resourceInputs, opts);
}
}
exports.RegionBackendService = RegionBackendService;
/** @internal */
RegionBackendService.__pulumiType = 'gcp:compute/regionBackendService:RegionBackendService';
//# sourceMappingURL=regionBackendService.js.map