-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
update generated docs action
committed
Jan 2, 2025
1 parent
ffd28c4
commit 89fb0a0
Showing
1 changed file
with
55 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "env0_vcs_connection Resource - terraform-provider-env0" | ||
subcategory: "" | ||
description: |- | ||
--- | ||
|
||
# env0_vcs_connection (Resource) | ||
|
||
|
||
|
||
## Example Usage | ||
|
||
```terraform | ||
# Create a GitHub Enterprise VCS connection with default agent | ||
resource "env0_vcs_connection" "github_enterprise" { | ||
name = "github-enterprise" | ||
type = "GitHubEnterprise" | ||
url = "https://github.example.com" | ||
vcs_agent_key = "ENV0_DEFAULT" | ||
} | ||
# Create a GitLab Enterprise VCS connection with custom agent | ||
resource "env0_vcs_connection" "gitlab_enterprise" { | ||
name = "gitlab-enterprise" | ||
type = "GitLabEnterprise" | ||
url = "https://gitlab.example.com" | ||
vcs_agent_key = "my-custom-agent" | ||
} | ||
# Create a BitBucket Server VCS connection | ||
resource "env0_vcs_connection" "bitbucket_server" { | ||
name = "bitbucket-server" | ||
type = "BitBucketServer" | ||
url = "https://bitbucket.example.com" | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `name` (String) name of the VCS connection | ||
- `type` (String) the VCS type (BitBucketServer, GitLabEnterprise, or GitHubEnterprise) | ||
- `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) | ||
|
||
### Optional | ||
|
||
- `vcs_agent_key` (String) VCS agent key. Use a custom agent key or 'ENV0_DEFAULT' to use the default env0 agent | ||
|
||
### Read-Only | ||
|
||
- `id` (String) The ID of this resource. |