google_compute_region_autoscaler.md

google_compute_region_autoscaler

back

Index

• Example Usage
• Variables
• Resource
• Outputs

Terraform

terraform {
  required_providers {
    google-beta = ">= 3.63.0"
  }
}

top

Example Usage

module "google_compute_region_autoscaler" {
  source = "./modules/google-beta/r/google_compute_region_autoscaler"

  # description - (optional) is a type of string
  description = null
  # name - (required) is a type of string
  name = null
  # project - (optional) is a type of string
  project = null
  # region - (optional) is a type of string
  region = null
  # target - (required) is a type of string
  target = null

  autoscaling_policy = [{
    cooldown_period = null
    cpu_utilization = [{
      predictive_method = null
      target            = null
    }]
    load_balancing_utilization = [{
      target = null
    }]
    max_replicas = null
    metric = [{
      filter                     = null
      name                       = null
      single_instance_assignment = null
      target                     = null
      type                       = null
    }]
    min_replicas = null
    mode         = null
    scale_down_control = [{
      max_scaled_down_replicas = [{
        fixed   = null
        percent = null
      }]
      time_window_sec = null
    }]
    scale_in_control = [{
      max_scaled_in_replicas = [{
        fixed   = null
        percent = null
      }]
      time_window_sec = null
    }]
    scaling_schedules = [{
      description           = null
      disabled              = null
      duration_sec          = null
      min_required_replicas = null
      name                  = null
      schedule              = null
      time_zone             = null
    }]
  }]

  timeouts = [{
    create = null
    delete = null
    update = null
  }]
}

top

Variables

variable "description" {
  description = "(optional) - An optional description of this resource."
  type        = string
  default     = null
}

variable "name" {
  description = "(required) - Name of the resource. The name must be 1-63 characters long and match\nthe regular expression '[a-z]([-a-z0-9]*[a-z0-9])?' which means the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash."
  type        = string
}

variable "project" {
  description = "(optional)"
  type        = string
  default     = null
}

variable "region" {
  description = "(optional) - URL of the region where the instance group resides."
  type        = string
  default     = null
}

variable "target" {
  description = "(required) - URL of the managed instance group that this autoscaler will scale."
  type        = string
}

variable "autoscaling_policy" {
  description = "nested block: NestingList, min items: 1, max items: 1"
  type = set(object(
    {
      cooldown_period = number
      cpu_utilization = list(object(
        {
          predictive_method = string
          target            = number
        }
      ))
      load_balancing_utilization = list(object(
        {
          target = number
        }
      ))
      max_replicas = number
      metric = list(object(
        {
          filter                     = string
          name                       = string
          single_instance_assignment = number
          target                     = number
          type                       = string
        }
      ))
      min_replicas = number
      mode         = string
      scale_down_control = list(object(
        {
          max_scaled_down_replicas = list(object(
            {
              fixed   = number
              percent = number
            }
          ))
          time_window_sec = number
        }
      ))
      scale_in_control = list(object(
        {
          max_scaled_in_replicas = list(object(
            {
              fixed   = number
              percent = number
            }
          ))
          time_window_sec = number
        }
      ))
      scaling_schedules = set(object(
        {
          description           = string
          disabled              = bool
          duration_sec          = number
          min_required_replicas = number
          name                  = string
          schedule              = string
          time_zone             = string
        }
      ))
    }
  ))
}

variable "timeouts" {
  description = "nested block: NestingSingle, min items: 0, max items: 0"
  type = set(object(
    {
      create = string
      delete = string
      update = string
    }
  ))
  default = []
}

top

Resource

resource "google_compute_region_autoscaler" "this" {
  # description - (optional) is a type of string
  description = var.description
  # name - (required) is a type of string
  name = var.name
  # project - (optional) is a type of string
  project = var.project
  # region - (optional) is a type of string
  region = var.region
  # target - (required) is a type of string
  target = var.target

  dynamic "autoscaling_policy" {
    for_each = var.autoscaling_policy
    content {
      # cooldown_period - (optional) is a type of number
      cooldown_period = autoscaling_policy.value["cooldown_period"]
      # max_replicas - (required) is a type of number
      max_replicas = autoscaling_policy.value["max_replicas"]
      # min_replicas - (required) is a type of number
      min_replicas = autoscaling_policy.value["min_replicas"]
      # mode - (optional) is a type of string
      mode = autoscaling_policy.value["mode"]

      dynamic "cpu_utilization" {
        for_each = autoscaling_policy.value.cpu_utilization
        content {
          # predictive_method - (optional) is a type of string
          predictive_method = cpu_utilization.value["predictive_method"]
          # target - (required) is a type of number
          target = cpu_utilization.value["target"]
        }
      }

      dynamic "load_balancing_utilization" {
        for_each = autoscaling_policy.value.load_balancing_utilization
        content {
          # target - (required) is a type of number
          target = load_balancing_utilization.value["target"]
        }
      }

      dynamic "metric" {
        for_each = autoscaling_policy.value.metric
        content {
          # filter - (optional) is a type of string
          filter = metric.value["filter"]
          # name - (required) is a type of string
          name = metric.value["name"]
          # single_instance_assignment - (optional) is a type of number
          single_instance_assignment = metric.value["single_instance_assignment"]
          # target - (optional) is a type of number
          target = metric.value["target"]
          # type - (optional) is a type of string
          type = metric.value["type"]
        }
      }

      dynamic "scale_down_control" {
        for_each = autoscaling_policy.value.scale_down_control
        content {
          # time_window_sec - (optional) is a type of number
          time_window_sec = scale_down_control.value["time_window_sec"]

          dynamic "max_scaled_down_replicas" {
            for_each = scale_down_control.value.max_scaled_down_replicas
            content {
              # fixed - (optional) is a type of number
              fixed = max_scaled_down_replicas.value["fixed"]
              # percent - (optional) is a type of number
              percent = max_scaled_down_replicas.value["percent"]
            }
          }

        }
      }

      dynamic "scale_in_control" {
        for_each = autoscaling_policy.value.scale_in_control
        content {
          # time_window_sec - (optional) is a type of number
          time_window_sec = scale_in_control.value["time_window_sec"]

          dynamic "max_scaled_in_replicas" {
            for_each = scale_in_control.value.max_scaled_in_replicas
            content {
              # fixed - (optional) is a type of number
              fixed = max_scaled_in_replicas.value["fixed"]
              # percent - (optional) is a type of number
              percent = max_scaled_in_replicas.value["percent"]
            }
          }

        }
      }

      dynamic "scaling_schedules" {
        for_each = autoscaling_policy.value.scaling_schedules
        content {
          # description - (optional) is a type of string
          description = scaling_schedules.value["description"]
          # disabled - (optional) is a type of bool
          disabled = scaling_schedules.value["disabled"]
          # duration_sec - (required) is a type of number
          duration_sec = scaling_schedules.value["duration_sec"]
          # min_required_replicas - (required) is a type of number
          min_required_replicas = scaling_schedules.value["min_required_replicas"]
          # name - (required) is a type of string
          name = scaling_schedules.value["name"]
          # schedule - (required) is a type of string
          schedule = scaling_schedules.value["schedule"]
          # time_zone - (optional) is a type of string
          time_zone = scaling_schedules.value["time_zone"]
        }
      }

    }
  }

  dynamic "timeouts" {
    for_each = var.timeouts
    content {
      # create - (optional) is a type of string
      create = timeouts.value["create"]
      # delete - (optional) is a type of string
      delete = timeouts.value["delete"]
      # update - (optional) is a type of string
      update = timeouts.value["update"]
    }
  }

}

top

Outputs

output "creation_timestamp" {
  description = "returns a string"
  value       = google_compute_region_autoscaler.this.creation_timestamp
}

output "id" {
  description = "returns a string"
  value       = google_compute_region_autoscaler.this.id
}

output "project" {
  description = "returns a string"
  value       = google_compute_region_autoscaler.this.project
}

output "region" {
  description = "returns a string"
  value       = google_compute_region_autoscaler.this.region
}

output "self_link" {
  description = "returns a string"
  value       = google_compute_region_autoscaler.this.self_link
}

output "this" {
  value = google_compute_region_autoscaler.this
}

top