source_credentials

Creates, updates, deletes, gets or lists a source_credentials resource.

Overview

Name	source_credentials
Type	Resource
Id	aws.codebuild.source_credentials

Fields

The following fields are returned by SELECT queries:

list_source_credentials

Name	Datatype	Description
source_credentials_infos	array	A list of SourceCredentialsInfo objects. Each SourceCredentialsInfo object includes the authentication type, token ARN, and type of source provider for one set of credentials.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_source_credentials	select	region		Returns a list of SourceCredentialsInfo objects.
delete_source_credentials	delete	region		Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
import_source_credentials	exec	region, token, serverType, authType		Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket repository.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_source_credentials

Returns a list of SourceCredentialsInfo objects.

SELECT
source_credentials_infos
FROM aws.codebuild.source_credentials
WHERE region = '{{ region }}' -- required
;

DELETE examples

delete_source_credentials

Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.

DELETE FROM aws.codebuild.source_credentials
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

import_source_credentials

Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket repository.

EXEC aws.codebuild.source_credentials.import_source_credentials 
@region='{{ region }}' --required 
@@json=
'{
"username": "{{ username }}", 
"token": "{{ token }}", 
"serverType": "{{ serverType }}", 
"authType": "{{ authType }}", 
"shouldOverwrite": {{ shouldOverwrite }}
}'
;