github.com/nathanielks/terraform@v0.6.1-0.20170509030759-13e1a62319dc/website/source/docs/providers/github/r/team.html.markdown (about)

     1  ---
     2  layout: "github"
     3  page_title: "GitHub: github_team"
     4  sidebar_current: "docs-github-resource-team"
     5  description: |-
     6    Provides a GitHub team resource.
     7  ---
     8  
     9  # github_team
    10  
    11  Provides a GitHub team resource.
    12  
    13  This resource allows you to add/remove teams from your organization. When applied,
    14  a new team will be created. When destroyed, that team will be removed.
    15  
    16  ## Example Usage
    17  
    18  ```hcl
    19  # Add a team to the organization
    20  resource "github_team" "some_team" {
    21    name        = "some-team"
    22    description = "Some cool team"
    23    privacy     = "closed"
    24  }
    25  ```
    26  
    27  ## Argument Reference
    28  
    29  The following arguments are supported:
    30  
    31  * `name` - (Required) The name of the team.
    32  * `description` - (Optional) A description of the team.
    33  * `privacy` - (Optional) The level of privacy for the team. Must be one of `secret` or `closed`.
    34                 Defaults to `secret`.
    35  
    36  ## Attributes Reference
    37  
    38  The following attributes are exported:
    39  
    40  * `id` - The ID of the created team.