-
Notifications
You must be signed in to change notification settings - Fork 9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add aws_codebuild_source_credential resource document
- Loading branch information
1 parent
b3cdb37
commit 979bd0d
Showing
2 changed files
with
52 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
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,48 @@ | ||
--- | ||
layout: "aws" | ||
page_title: "AWS: aws_codebuild_source_credential" | ||
sidebar_current: "docs-aws-resource-codebuild-source-credential" | ||
description: |- | ||
Provides a CodeBuild Source Credential resource. | ||
--- | ||
|
||
# aws_codebuild_project | ||
|
||
Provides a CodeBuild Source Credentials Resource. | ||
|
||
## Example Usage | ||
|
||
```hcl | ||
resource "aws_codebuild_source_credential" "example" { | ||
auth_type = "PERSONAL_ACCESS_TOKEN" | ||
server_type = "GITHUB" | ||
token = "example" | ||
} | ||
``` | ||
|
||
### Bitbucket Server Usage | ||
|
||
```hcl | ||
resource "aws_codebuild_source_credential" "example" { | ||
auth_type = "BASIC_AUTH" | ||
server_type = "BITBUCKET" | ||
token = "example" | ||
user_name = "test-user" | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
|
||
The following arguments are supported: | ||
|
||
* `auth_type` - (Required) The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API. | ||
* `server_type` - (Required) The source provider used for this project. | ||
* `token` - (Required) For `GitHub` or `GitHub Enterprise`, this is the personal access token. For `Bitbucket`, this is the app password. | ||
* `user_name` - (Optional) The Bitbucket username when the authType is `BASIC_AUTH`. This parameter is not valid for other types of source providers or connections. | ||
|
||
## Attributes Reference | ||
|
||
In addition to all arguments above, the following attributes are exported: | ||
|
||
* `id` - The ARN of Source Credential. | ||
* `arn` - The ARN of Source Credential. |