Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . codebuild ]

import-source-credentials

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  import-source-credentials
[--username <value>]
--token <value>
--server-type <value>
--auth-type <value>
[--should-overwrite | --no-should-overwrite]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--username (string)

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

--token (string)

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

--server-type (string)

The source provider used for this project.

Possible values:

  • GITHUB
  • BITBUCKET
  • GITHUB_ENTERPRISE

--auth-type (string)

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

Possible values:

  • OAUTH
  • BASIC_AUTH
  • PERSONAL_ACCESS_TOKEN

--should-overwrite | --no-should-overwrite (boolean)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

Connect an AWS CodeBuild user to a source provider by importing credentials for the source provider.

The following import-source-credentials example imports a token for a Bitbucket repository that uses BASIC_AUTH for its authentication type.

aws codebuild import-source-credentials --server-type BITBUCKET --auth-type BASIC_AUTH --token my-Bitbucket-password --username my-Bitbucket-username

Output:

{
    "arn": "arn:aws:codebuild:us-west-2:123456789012:token/bitbucket"
}

For more information, see Connect Source Providers with Access Tokens (CLI) in the AWS CodeBuild User Guide.

Output

arn -> (string)

The Amazon Resource Name (ARN) of the token.