google_sql_user.md

google_sql_user

back

Index

• Example Usage
• Variables
• Resource
• Outputs

Terraform

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

top

Example Usage

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

  # deletion_policy - (optional) is a type of string
  deletion_policy = null
  # host - (optional) is a type of string
  host = null
  # instance - (required) is a type of string
  instance = null
  # name - (required) is a type of string
  name = null
  # password - (optional) is a type of string
  password = null
  # project - (optional) is a type of string
  project = null
  # type - (optional) is a type of string
  type = null

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

top

Variables

variable "deletion_policy" {
  description = "(optional) - The deletion policy for the user. Setting ABANDON allows the resource\n\t\t\t\tto be abandoned rather than deleted. This is useful for Postgres, where users cannot be deleted from the API if they\n\t\t\t\thave been granted SQL roles. Possible values are: \"ABANDON\"."
  type        = string
  default     = null
}

variable "host" {
  description = "(optional) - The host the user can connect from. This is only supported for MySQL instances. Don't set this field for PostgreSQL instances. Can be an IP address. Changing this forces a new resource to be created."
  type        = string
  default     = null
}

variable "instance" {
  description = "(required) - The name of the Cloud SQL instance. Changing this forces a new resource to be created."
  type        = string
}

variable "name" {
  description = "(required) - The name of the user. Changing this forces a new resource to be created."
  type        = string
}

variable "password" {
  description = "(optional) - The password for the user. Can be updated. For Postgres instances this is a Required field, unless type is set to\n                either CLOUD_IAM_USER or CLOUD_IAM_SERVICE_ACCOUNT."
  type        = string
  default     = null
}

variable "project" {
  description = "(optional) - The ID of the project in which the resource belongs. If it is not provided, the provider project is used."
  type        = string
  default     = null
}

variable "type" {
  description = "(optional) - The user type. It determines the method to authenticate the user during login.\n                The default is the database's built-in user type. Flags include \"BUILT_IN\", \"CLOUD_IAM_USER\", or \"CLOUD_IAM_SERVICE_ACCOUNT\"."
  type        = string
  default     = null
}

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_sql_user" "this" {
  # deletion_policy - (optional) is a type of string
  deletion_policy = var.deletion_policy
  # host - (optional) is a type of string
  host = var.host
  # instance - (required) is a type of string
  instance = var.instance
  # name - (required) is a type of string
  name = var.name
  # password - (optional) is a type of string
  password = var.password
  # project - (optional) is a type of string
  project = var.project
  # type - (optional) is a type of string
  type = var.type

  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 "id" {
  description = "returns a string"
  value       = google_sql_user.this.id
}

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

output "this" {
  value = google_sql_user.this
}

top