interface CfnSourceCredentialProps

Language	Type name
.NET	`Amazon.CDK.AWS.CodeBuild.CfnSourceCredentialProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscodebuild#CfnSourceCredentialProps`
Java	`software.amazon.awscdk.services.codebuild.CfnSourceCredentialProps`
Python	`aws_cdk.aws_codebuild.CfnSourceCredentialProps`
TypeScript	`aws-cdk-lib` » `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 { aws_codebuild as codebuild } from 'aws-cdk-lib';
const cfnSourceCredentialProps: codebuild.CfnSourceCredentialProps = {
  authType: 'authType',
  serverType: 'serverType',
  token: 'token',

  // the properties below are optional
  username: 'username',
};

Properties

Name	Type	Description
authType	`string`	The type of authentication used by the credentials.
serverType	`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, PERSONAL_ACCESS_TOKEN, CODECONNECTIONS, or SECRETS_MANAGER.

serverType

Type: string

The type of source provider.

The valid options are GITHUB, GITHUB_ENTERPRISE, GITLAB, GITLAB_SELF_MANAGED, or BITBUCKET.

token

Type: string

For GitHub or GitHub Enterprise, this is the personal access token.

For Bitbucket, this is either the access token or the app password. For the authType CODECONNECTIONS, this is the connectionArn . For the authType SECRETS_MANAGER, this is the secretArn .

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.