Class Autoscaler (0.2.1) 

Autoscaler(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents an Autoscaler resource.

Google Compute Engine has two Autoscaler resources:

  • Zonal </compute/docs/reference/rest/{$api_version}/autoscalers> * Regional </compute/docs/reference/rest/{$api_version}/regionAutoscalers>

Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances.

For zonal managed instance groups resource, use the autoscaler resource.

For regional managed instance groups, use the regionAutoscalers resource. (== resource_for {$api_version}.autoscalers ==) (== resource_for {$api_version}.regionAutoscalers ==)

Attributes

NameDescription
autoscaling_policy google.cloud.compute_v1.types.AutoscalingPolicy
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%.
creation_timestamp str
[Output Only] Creation timestamp in RFC3339 text format.
description str
An optional description of this resource. Provide this property when you create the resource.
id str
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
kind str
[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
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]([-a-z0-9]*[a-z0-9])? 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.
recommended_size int
[Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction.
region str
[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).
self_link str
[Output Only] Server-defined URL for the resource.
status google.cloud.compute_v1.types.Autoscaler.Status
[Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future.
status_details Sequence[google.cloud.compute_v1.types.AutoscalerStatusDetails]
[Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.
target str
URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler.
zone str
[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).

Classes

Status

Status(value)

[Output Only] The status of the autoscaler configuration. Current set of possible values:

  • PENDING: Autoscaler backend hasn't read new/updated configuration.
  • DELETING: Configuration is being deleted.
  • ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field.
  • ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future.