terraform-modules/manage-teams/variables.tf

/**
 * Copyright 2022 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

variable "name" {
  description = "(Required) The name of the team."
  type        = string
}

# ---------------------------------------------------------------------------------------------------------------------
# OPTIONAL VARIABLES
# These variables have defaults, but may be overridden.
# ---------------------------------------------------------------------------------------------------------------------

variable "description" {
  description = "(Optional) A description of the team."
  type        = string
  default     = ""
}

#DO NOT USE SECRET TEAMS AS THEY CAN'T BE NESTED
variable "privacy" {
  description = "(Optional) The level of privacy for the team. Must be one of secret or closed."
  type        = string
  default     = "closed"
}

variable "parent_team_id" {
  description = "(Optional) The ID of the parent team, if this is a nested team."
  type        = number
  default     = null
}

variable "maintainers" {
  description = "(Optional) A list of users that will be added to the current team with maintainer permissions."
  type        = set(string)
  default     = []
}

variable "members" {
  description = "(Optional) A list of users that will be added to the current team with member permissions."
  type        = set(string)
  default     = []
}

variable "admin_repositories" {
  description = "(Optional) A list of repository names the current team should get admin (full) permission to."
  type        = set(string)
  default     = []
}

variable "maintain_repositories" {
  description = "(Optional) A list of repository names the current team should get push (maintain) permission to."
  type        = set(string)
  default     = []
}

variable "push_repositories" {
  description = "(Optional) A list of repository names the current team should get push (read-write) permission to."
  type        = set(string)
  default     = []
}

variable "triage_repositories" {
  description = "(Optional) A list of repository names the current team should get push (triage) permission to."
  type        = set(string)
  default     = []
}

variable "pull_repositories" {
  description = "(Optional) A list of repository names the current team should get pull (read-only) permission to."
  type        = set(string)
  default     = []
}

variable "module_depends_on" {
  type        = any
  description = "(Optional) A list of external resources the module depends_on. Default is []."
  default     = []
}