class GitHubSourceCredentials (construct)

Language	Type name
.NET	Amazon.CDK.AWS.CodeBuild.GitHubSourceCredentials
Java	software.amazon.awscdk.services.codebuild.GitHubSourceCredentials
Python	aws_cdk.aws_codebuild.GitHubSourceCredentials
TypeScript (source)	@aws-cdk/aws-codebuild » GitHubSourceCredentials

Implements IConstruct, IConstruct, IDependable, IResource

The source credentials used when contacting the GitHub API.

Note: CodeBuild only allows a single credential for GitHub to be saved in a given AWS account in a given region - any attempt to add more than one will result in an error.

Example

new codebuild.GitHubSourceCredentials(this, 'CodeBuildGitHubCreds', {
  accessToken: SecretValue.secretsManager('my-token'),
});
// GitHub Enterprise is almost the same,
// except the class is called GitHubEnterpriseSourceCredentials

Initializer

new GitHubSourceCredentials(scope: Construct, id: string, props: GitHubSourceCredentialsProps)

Parameters

• scope Construct
• id string
• props GitHubSourceCredentialsProps

Construct Props

Name	Type	Description
accessToken	SecretValue	The personal access token to use when contacting the GitHub API.

---

accessToken

Type: SecretValue

The personal access token to use when contacting the GitHub API.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	ConstructNode	The construct tree node associated with this construct.
stack	Stack	The stack in which this resource is defined.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.