pulumi-gcp-kotlin/com.pulumi.gcp.compute.kotlin/RegionAutoscaler

RegionAutoscaler

class RegionAutoscaler : KotlinCustomResource

Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. To get more information about RegionAutoscaler, see:

Example Usage

Region Autoscaler Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const foobarInstanceTemplate = new gcp.compute.InstanceTemplate("foobar", {
    name: "my-instance-template",
    machineType: "e2-standard-4",
    disks: [{
        sourceImage: "debian-cloud/debian-11",
        diskSizeGb: 250,
    }],
    networkInterfaces: [{
        network: "default",
        accessConfigs: [{
            networkTier: "PREMIUM",
        }],
    }],
    serviceAccount: {
        scopes: [
            "https://www.googleapis.com/auth/devstorage.read_only",
            "https://www.googleapis.com/auth/logging.write",
            "https://www.googleapis.com/auth/monitoring.write",
            "https://www.googleapis.com/auth/pubsub",
            "https://www.googleapis.com/auth/service.management.readonly",
            "https://www.googleapis.com/auth/servicecontrol",
            "https://www.googleapis.com/auth/trace.append",
        ],
    },
});
const foobarTargetPool = new gcp.compute.TargetPool("foobar", {name: "my-target-pool"});
const foobarRegionInstanceGroupManager = new gcp.compute.RegionInstanceGroupManager("foobar", {
    name: "my-region-igm",
    region: "us-central1",
    versions: [{
        instanceTemplate: foobarInstanceTemplate.id,
        name: "primary",
    }],
    targetPools: [foobarTargetPool.id],
    baseInstanceName: "foobar",
});
const foobar = new gcp.compute.RegionAutoscaler("foobar", {
    name: "my-region-autoscaler",
    region: "us-central1",
    target: foobarRegionInstanceGroupManager.id,
    autoscalingPolicy: {
        maxReplicas: 5,
        minReplicas: 1,
        cooldownPeriod: 60,
        cpuUtilization: {
            target: 0.5,
        },
    },
});
const debian9 = gcp.compute.getImage({
    family: "debian-11",
    project: "debian-cloud",
});
Content copied to clipboard
import pulumi
import pulumi_gcp as gcp
foobar_instance_template = gcp.compute.InstanceTemplate("foobar",
    name="my-instance-template",
    machine_type="e2-standard-4",
    disks=[{
        "source_image": "debian-cloud/debian-11",
        "disk_size_gb": 250,
    }],
    network_interfaces=[{
        "network": "default",
        "access_configs": [{
            "network_tier": "PREMIUM",
        }],
    }],
    service_account={
        "scopes": [
            "https://www.googleapis.com/auth/devstorage.read_only",
            "https://www.googleapis.com/auth/logging.write",
            "https://www.googleapis.com/auth/monitoring.write",
            "https://www.googleapis.com/auth/pubsub",
            "https://www.googleapis.com/auth/service.management.readonly",
            "https://www.googleapis.com/auth/servicecontrol",
            "https://www.googleapis.com/auth/trace.append",
        ],
    })
foobar_target_pool = gcp.compute.TargetPool("foobar", name="my-target-pool")
foobar_region_instance_group_manager = gcp.compute.RegionInstanceGroupManager("foobar",
    name="my-region-igm",
    region="us-central1",
    versions=[{
        "instance_template": foobar_instance_template.id,
        "name": "primary",
    }],
    target_pools=[foobar_target_pool.id],
    base_instance_name="foobar")
foobar = gcp.compute.RegionAutoscaler("foobar",
    name="my-region-autoscaler",
    region="us-central1",
    target=foobar_region_instance_group_manager.id,
    autoscaling_policy={
        "max_replicas": 5,
        "min_replicas": 1,
        "cooldown_period": 60,
        "cpu_utilization": {
            "target": 0.5,
        },
    })
debian9 = gcp.compute.get_image(family="debian-11",
    project="debian-cloud")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var foobarInstanceTemplate = new Gcp.Compute.InstanceTemplate("foobar", new()
    {
        Name = "my-instance-template",
        MachineType = "e2-standard-4",
        Disks = new[]
        {
            new Gcp.Compute.Inputs.InstanceTemplateDiskArgs
            {
                SourceImage = "debian-cloud/debian-11",
                DiskSizeGb = 250,
            },
        },
        NetworkInterfaces = new[]
        {
            new Gcp.Compute.Inputs.InstanceTemplateNetworkInterfaceArgs
            {
                Network = "default",
                AccessConfigs = new[]
                {
                    new Gcp.Compute.Inputs.InstanceTemplateNetworkInterfaceAccessConfigArgs
                    {
                        NetworkTier = "PREMIUM",
                    },
                },
            },
        },
        ServiceAccount = new Gcp.Compute.Inputs.InstanceTemplateServiceAccountArgs
        {
            Scopes = new[]
            {
                "https://www.googleapis.com/auth/devstorage.read_only",
                "https://www.googleapis.com/auth/logging.write",
                "https://www.googleapis.com/auth/monitoring.write",
                "https://www.googleapis.com/auth/pubsub",
                "https://www.googleapis.com/auth/service.management.readonly",
                "https://www.googleapis.com/auth/servicecontrol",
                "https://www.googleapis.com/auth/trace.append",
            },
        },
    });
    var foobarTargetPool = new Gcp.Compute.TargetPool("foobar", new()
    {
        Name = "my-target-pool",
    });
    var foobarRegionInstanceGroupManager = new Gcp.Compute.RegionInstanceGroupManager("foobar", new()
    {
        Name = "my-region-igm",
        Region = "us-central1",
        Versions = new[]
        {
            new Gcp.Compute.Inputs.RegionInstanceGroupManagerVersionArgs
            {
                InstanceTemplate = foobarInstanceTemplate.Id,
                Name = "primary",
            },
        },
        TargetPools = new[]
        {
            foobarTargetPool.Id,
        },
        BaseInstanceName = "foobar",
    });
    var foobar = new Gcp.Compute.RegionAutoscaler("foobar", new()
    {
        Name = "my-region-autoscaler",
        Region = "us-central1",
        Target = foobarRegionInstanceGroupManager.Id,
        AutoscalingPolicy = new Gcp.Compute.Inputs.RegionAutoscalerAutoscalingPolicyArgs
        {
            MaxReplicas = 5,
            MinReplicas = 1,
            CooldownPeriod = 60,
            CpuUtilization = new Gcp.Compute.Inputs.RegionAutoscalerAutoscalingPolicyCpuUtilizationArgs
            {
                Target = 0.5,
            },
        },
    });
    var debian9 = Gcp.Compute.GetImage.Invoke(new()
    {
        Family = "debian-11",
        Project = "debian-cloud",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		foobarInstanceTemplate, err := compute.NewInstanceTemplate(ctx, "foobar", &compute.InstanceTemplateArgs{
			Name:        pulumi.String("my-instance-template"),
			MachineType: pulumi.String("e2-standard-4"),
			Disks: compute.InstanceTemplateDiskArray{
				&compute.InstanceTemplateDiskArgs{
					SourceImage: pulumi.String("debian-cloud/debian-11"),
					DiskSizeGb:  pulumi.Int(250),
				},
			},
			NetworkInterfaces: compute.InstanceTemplateNetworkInterfaceArray{
				&compute.InstanceTemplateNetworkInterfaceArgs{
					Network: pulumi.String("default"),
					AccessConfigs: compute.InstanceTemplateNetworkInterfaceAccessConfigArray{
						&compute.InstanceTemplateNetworkInterfaceAccessConfigArgs{
							NetworkTier: pulumi.String("PREMIUM"),
						},
					},
				},
			},
			ServiceAccount: &compute.InstanceTemplateServiceAccountArgs{
				Scopes: pulumi.StringArray{
					pulumi.String("https://www.googleapis.com/auth/devstorage.read_only"),
					pulumi.String("https://www.googleapis.com/auth/logging.write"),
					pulumi.String("https://www.googleapis.com/auth/monitoring.write"),
					pulumi.String("https://www.googleapis.com/auth/pubsub"),
					pulumi.String("https://www.googleapis.com/auth/service.management.readonly"),
					pulumi.String("https://www.googleapis.com/auth/servicecontrol"),
					pulumi.String("https://www.googleapis.com/auth/trace.append"),
				},
			},
		})
		if err != nil {
			return err
		}
		foobarTargetPool, err := compute.NewTargetPool(ctx, "foobar", &compute.TargetPoolArgs{
			Name: pulumi.String("my-target-pool"),
		})
		if err != nil {
			return err
		}
		foobarRegionInstanceGroupManager, err := compute.NewRegionInstanceGroupManager(ctx, "foobar", &compute.RegionInstanceGroupManagerArgs{
			Name:   pulumi.String("my-region-igm"),
			Region: pulumi.String("us-central1"),
			Versions: compute.RegionInstanceGroupManagerVersionArray{
				&compute.RegionInstanceGroupManagerVersionArgs{
					InstanceTemplate: foobarInstanceTemplate.ID(),
					Name:             pulumi.String("primary"),
				},
			},
			TargetPools: pulumi.StringArray{
				foobarTargetPool.ID(),
			},
			BaseInstanceName: pulumi.String("foobar"),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewRegionAutoscaler(ctx, "foobar", &compute.RegionAutoscalerArgs{
			Name:   pulumi.String("my-region-autoscaler"),
			Region: pulumi.String("us-central1"),
			Target: foobarRegionInstanceGroupManager.ID(),
			AutoscalingPolicy: &compute.RegionAutoscalerAutoscalingPolicyArgs{
				MaxReplicas:    pulumi.Int(5),
				MinReplicas:    pulumi.Int(1),
				CooldownPeriod: pulumi.Int(60),
				CpuUtilization: &compute.RegionAutoscalerAutoscalingPolicyCpuUtilizationArgs{
					Target: pulumi.Float64(0.5),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = compute.LookupImage(ctx, &compute.LookupImageArgs{
			Family:  pulumi.StringRef("debian-11"),
			Project: pulumi.StringRef("debian-cloud"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.InstanceTemplate;
import com.pulumi.gcp.compute.InstanceTemplateArgs;
import com.pulumi.gcp.compute.inputs.InstanceTemplateDiskArgs;
import com.pulumi.gcp.compute.inputs.InstanceTemplateNetworkInterfaceArgs;
import com.pulumi.gcp.compute.inputs.InstanceTemplateServiceAccountArgs;
import com.pulumi.gcp.compute.TargetPool;
import com.pulumi.gcp.compute.TargetPoolArgs;
import com.pulumi.gcp.compute.RegionInstanceGroupManager;
import com.pulumi.gcp.compute.RegionInstanceGroupManagerArgs;
import com.pulumi.gcp.compute.inputs.RegionInstanceGroupManagerVersionArgs;
import com.pulumi.gcp.compute.RegionAutoscaler;
import com.pulumi.gcp.compute.RegionAutoscalerArgs;
import com.pulumi.gcp.compute.inputs.RegionAutoscalerAutoscalingPolicyArgs;
import com.pulumi.gcp.compute.inputs.RegionAutoscalerAutoscalingPolicyCpuUtilizationArgs;
import com.pulumi.gcp.compute.ComputeFunctions;
import com.pulumi.gcp.compute.inputs.GetImageArgs;
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 foobarInstanceTemplate = new InstanceTemplate("foobarInstanceTemplate", InstanceTemplateArgs.builder()
            .name("my-instance-template")
            .machineType("e2-standard-4")
            .disks(InstanceTemplateDiskArgs.builder()
                .sourceImage("debian-cloud/debian-11")
                .diskSizeGb(250)
                .build())
            .networkInterfaces(InstanceTemplateNetworkInterfaceArgs.builder()
                .network("default")
                .accessConfigs(InstanceTemplateNetworkInterfaceAccessConfigArgs.builder()
                    .networkTier("PREMIUM")
                    .build())
                .build())
            .serviceAccount(InstanceTemplateServiceAccountArgs.builder()
                .scopes(
                    "https://www.googleapis.com/auth/devstorage.read_only",
                    "https://www.googleapis.com/auth/logging.write",
                    "https://www.googleapis.com/auth/monitoring.write",
                    "https://www.googleapis.com/auth/pubsub",
                    "https://www.googleapis.com/auth/service.management.readonly",
                    "https://www.googleapis.com/auth/servicecontrol",
                    "https://www.googleapis.com/auth/trace.append")
                .build())
            .build());
        var foobarTargetPool = new TargetPool("foobarTargetPool", TargetPoolArgs.builder()
            .name("my-target-pool")
            .build());
        var foobarRegionInstanceGroupManager = new RegionInstanceGroupManager("foobarRegionInstanceGroupManager", RegionInstanceGroupManagerArgs.builder()
            .name("my-region-igm")
            .region("us-central1")
            .versions(RegionInstanceGroupManagerVersionArgs.builder()
                .instanceTemplate(foobarInstanceTemplate.id())
                .name("primary")
                .build())
            .targetPools(foobarTargetPool.id())
            .baseInstanceName("foobar")
            .build());
        var foobar = new RegionAutoscaler("foobar", RegionAutoscalerArgs.builder()
            .name("my-region-autoscaler")
            .region("us-central1")
            .target(foobarRegionInstanceGroupManager.id())
            .autoscalingPolicy(RegionAutoscalerAutoscalingPolicyArgs.builder()
                .maxReplicas(5)
                .minReplicas(1)
                .cooldownPeriod(60)
                .cpuUtilization(RegionAutoscalerAutoscalingPolicyCpuUtilizationArgs.builder()
                    .target(0.5)
                    .build())
                .build())
            .build());
        final var debian9 = ComputeFunctions.getImage(GetImageArgs.builder()
            .family("debian-11")
            .project("debian-cloud")
            .build());
    }
}
Content copied to clipboard
resources:
  foobar:
    type: gcp:compute:RegionAutoscaler
    properties:
      name: my-region-autoscaler
      region: us-central1
      target: ${foobarRegionInstanceGroupManager.id}
      autoscalingPolicy:
        maxReplicas: 5
        minReplicas: 1
        cooldownPeriod: 60
        cpuUtilization:
          target: 0.5
  foobarInstanceTemplate:
    type: gcp:compute:InstanceTemplate
    name: foobar
    properties:
      name: my-instance-template
      machineType: e2-standard-4
      disks:
        - sourceImage: debian-cloud/debian-11
          diskSizeGb: 250
      networkInterfaces:
        - network: default
          accessConfigs:
            - networkTier: PREMIUM
      serviceAccount:
        scopes:
          - https://www.googleapis.com/auth/devstorage.read_only
          - https://www.googleapis.com/auth/logging.write
          - https://www.googleapis.com/auth/monitoring.write
          - https://www.googleapis.com/auth/pubsub
          - https://www.googleapis.com/auth/service.management.readonly
          - https://www.googleapis.com/auth/servicecontrol
          - https://www.googleapis.com/auth/trace.append
  foobarTargetPool:
    type: gcp:compute:TargetPool
    name: foobar
    properties:
      name: my-target-pool
  foobarRegionInstanceGroupManager:
    type: gcp:compute:RegionInstanceGroupManager
    name: foobar
    properties:
      name: my-region-igm
      region: us-central1
      versions:
        - instanceTemplate: ${foobarInstanceTemplate.id}
          name: primary
      targetPools:
        - ${foobarTargetPool.id}
      baseInstanceName: foobar
variables:
  debian9:
    fn::invoke:
      Function: gcp:compute:getImage
      Arguments:
        family: debian-11
        project: debian-cloud
Content copied to clipboard

Import

RegionAutoscaler can be imported using any of these accepted formats:

  • projects/{{project}}/regions/{{region}}/autoscalers/{{name}}

  • {{project}}/{{region}}/{{name}}

  • {{region}}/{{name}}

  • {{name}} When using the pulumi import command, RegionAutoscaler can be imported using one of the formats above. For example:

$ pulumi import gcp:compute/regionAutoscaler:RegionAutoscaler default projects/{{project}}/regions/{{region}}/autoscalers/{{name}}
Content copied to clipboard
$ pulumi import gcp:compute/regionAutoscaler:RegionAutoscaler default {{project}}/{{region}}/{{name}}
Content copied to clipboard
$ pulumi import gcp:compute/regionAutoscaler:RegionAutoscaler default {{region}}/{{name}}
Content copied to clipboard
$ pulumi import gcp:compute/regionAutoscaler:RegionAutoscaler default {{name}}
Content copied to clipboard

Properties

Link copied to clipboard
val autoscalingPolicy: Output<RegionAutoscalerAutoscalingPolicy>

The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%. Structure is documented below.

Link copied to clipboard
val creationTimestamp: Output<String>

Creation timestamp in RFC3339 text format.

Link copied to clipboard
val description: Output<String>?

An optional description of this resource.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val name: Output<String>

Name of the resource. 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.

Link copied to clipboard
val project: Output<String>
Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val region: Output<String>

URL of the region where the instance group resides.

Link copied to clipboard
val selfLink: Output<String>

The URI of the created resource.

Link copied to clipboard
val target: Output<String>

URL of the managed instance group that this autoscaler will scale.

Link copied to clipboard
val urn: Output<String>