interface CfnSourceCredentialProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.CodeBuild.CfnSourceCredentialProps |
Java | software.amazon.awscdk.services.codebuild.CfnSourceCredentialProps |
Python | aws_cdk.aws_codebuild.CfnSourceCredentialProps |
TypeScript | @aws-cdk/aws-codebuild » CfnSourceCredentialProps |
Properties for defining a CfnSourceCredential
.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as codebuild from '@aws-cdk/aws-codebuild';
const cfnSourceCredentialProps: codebuild.CfnSourceCredentialProps = {
authType: 'authType',
serverType: 'serverType',
token: 'token',
// the properties below are optional
username: 'username',
};
Properties
Name | Type | Description |
---|---|---|
auth | string | The type of authentication used by the credentials. |
server | string | The type of source provider. |
token | string | For GitHub or GitHub Enterprise, this is the personal access token. |
username? | string | The Bitbucket username when the authType is BASIC_AUTH. |
authType
Type:
string
The type of authentication used by the credentials.
Valid options are OAUTH, BASIC_AUTH, or PERSONAL_ACCESS_TOKEN.
serverType
Type:
string
The type of source provider.
The valid options are GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.
token
Type:
string
For GitHub or GitHub Enterprise, this is the personal access token.
For Bitbucket, this is the app password.
username?
Type:
string
(optional)
The Bitbucket username when the authType
is BASIC_AUTH.
This parameter is not valid for other types of source providers or connections.