|
| 1 | +--- |
| 2 | +# generated by https://github.com/hashicorp/terraform-plugin-docs |
| 3 | +page_title: "env0_vcs_connection Resource - terraform-provider-env0" |
| 4 | +subcategory: "" |
| 5 | +description: |- |
| 6 | + |
| 7 | +--- |
| 8 | + |
| 9 | +# env0_vcs_connection (Resource) |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | +## Example Usage |
| 14 | + |
| 15 | +```terraform |
| 16 | +# Create a GitHub Enterprise VCS connection with default agent |
| 17 | +resource "env0_vcs_connection" "github_enterprise" { |
| 18 | + name = "github-enterprise" |
| 19 | + type = "GitHubEnterprise" |
| 20 | + url = "https://github.example.com" |
| 21 | + vcs_agent_key = "ENV0_DEFAULT" |
| 22 | +} |
| 23 | +
|
| 24 | +# Create a GitLab Enterprise VCS connection with custom agent |
| 25 | +resource "env0_vcs_connection" "gitlab_enterprise" { |
| 26 | + name = "gitlab-enterprise" |
| 27 | + type = "GitLabEnterprise" |
| 28 | + url = "https://gitlab.example.com" |
| 29 | + vcs_agent_key = "my-custom-agent" |
| 30 | +} |
| 31 | +
|
| 32 | +# Create a BitBucket Server VCS connection |
| 33 | +resource "env0_vcs_connection" "bitbucket_server" { |
| 34 | + name = "bitbucket-server" |
| 35 | + type = "BitBucketServer" |
| 36 | + url = "https://bitbucket.example.com" |
| 37 | +} |
| 38 | +``` |
| 39 | + |
| 40 | +<!-- schema generated by tfplugindocs --> |
| 41 | +## Schema |
| 42 | + |
| 43 | +### Required |
| 44 | + |
| 45 | +- `name` (String) name of the VCS connection |
| 46 | +- `type` (String) the VCS type (BitBucketServer, GitLabEnterprise, or GitHubEnterprise) |
| 47 | +- `url` (String) URL of the VCS server. This can either be a 'VCS URL' (e.g.: https://github.com) or 'Repository URL' (E.g.: https://github.com/env0/myrepo) |
| 48 | + |
| 49 | +### Optional |
| 50 | + |
| 51 | +- `vcs_agent_key` (String) VCS agent key. Use a custom agent key or 'ENV0_DEFAULT' to use the default env0 agent |
| 52 | + |
| 53 | +### Read-Only |
| 54 | + |
| 55 | +- `id` (String) The ID of this resource. |
0 commit comments