You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CodeBuild::Types::ImportSourceCredentialsInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb

Overview

Note:

When making an API call, you may pass ImportSourceCredentialsInput data as a hash:

{
  username: "NonEmptyString",
  token: "SensitiveNonEmptyString", # required
  server_type: "GITHUB", # required, accepts GITHUB, BITBUCKET, GITHUB_ENTERPRISE
  auth_type: "OAUTH", # required, accepts OAUTH, BASIC_AUTH, PERSONAL_ACCESS_TOKEN
  should_overwrite: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#auth_typeString

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.

Returns:

  • (String)


1176
1177
1178
1179
1180
1181
1182
1183
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1176

class ImportSourceCredentialsInput < Struct.new(
  :username,
  :token,
  :server_type,
  :auth_type,
  :should_overwrite)
  include Aws::Structure
end

#server_typeString

The source provider used for this project.

Returns:

  • (String)


1176
1177
1178
1179
1180
1181
1182
1183
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1176

class ImportSourceCredentialsInput < Struct.new(
  :username,
  :token,
  :server_type,
  :auth_type,
  :should_overwrite)
  include Aws::Structure
end

#should_overwriteBoolean

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

Returns:

  • (Boolean)


1176
1177
1178
1179
1180
1181
1182
1183
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1176

class ImportSourceCredentialsInput < Struct.new(
  :username,
  :token,
  :server_type,
  :auth_type,
  :should_overwrite)
  include Aws::Structure
end

#tokenString

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

Returns:

  • (String)


1176
1177
1178
1179
1180
1181
1182
1183
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1176

class ImportSourceCredentialsInput < Struct.new(
  :username,
  :token,
  :server_type,
  :auth_type,
  :should_overwrite)
  include Aws::Structure
end

#usernameString

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

Returns:

  • (String)


1176
1177
1178
1179
1180
1181
1182
1183
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1176

class ImportSourceCredentialsInput < Struct.new(
  :username,
  :token,
  :server_type,
  :auth_type,
  :should_overwrite)
  include Aws::Structure
end