importSourceCredentials method

Future<ImportSourceCredentialsOutput> importSourceCredentials({ required AuthType authType, required ServerType serverType, required String token, bool? shouldOverwrite, String? username, })

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.

May throw AccountLimitExceededException. May throw InvalidInputException. May throw ResourceAlreadyExistsException.

Parameter authType : The type of authentication used to connect to a GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket repository. An OAUTH connection is not supported by the API and must be created using the CodeBuild console.

Parameter serverType : The source provider used for this project.

Parameter token : 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.

Parameter shouldOverwrite : Set to false to prevent overwriting the repository source credentials. Set to true to overwrite the repository source credentials. The default value is true.

Parameter username : The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections.

Implementation

Future<ImportSourceCredentialsOutput> importSourceCredentials({
  required AuthType authType,
  required ServerType serverType,
  required String token,
  bool? shouldOverwrite,
  String? username,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'CodeBuild_20161006.ImportSourceCredentials'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'authType': authType.value,
      'serverType': serverType.value,
      'token': token,
      if (shouldOverwrite != null) 'shouldOverwrite': shouldOverwrite,
      if (username != null) 'username': username,
    },
  );

  return ImportSourceCredentialsOutput.fromJson(jsonResponse.body);
}