Amazonka.CodeBuild.ImportSourceCredentials

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

Creating a Request

data ImportSourceCredentials

See: newImportSourceCredentials smart constructor.

Constructors

ImportSourceCredentials'

Fields

• shouldOverwrite :: Maybe Bool

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

• username :: Maybe Text

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

• token :: Sensitive Text

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

• serverType :: ServerType

  The source provider used for this project.

• authType :: AuthType

  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 CodeBuild console.

Instances

ToJSON ImportSourceCredentials

Defined in Amazonka.CodeBuild.ImportSourceCredentials

Methods

toJSON :: ImportSourceCredentials -> Value

toEncoding :: ImportSourceCredentials -> Encoding

toJSONList :: [ImportSourceCredentials] -> Value

toEncodingList :: [ImportSourceCredentials] -> Encoding

ToHeaders ImportSourceCredentials

Defined in Amazonka.CodeBuild.ImportSourceCredentials

Methods

toHeaders :: ImportSourceCredentials -> [Header]

ToPath ImportSourceCredentials

Defined in Amazonka.CodeBuild.ImportSourceCredentials

Methods

toPath :: ImportSourceCredentials -> ByteString

ToQuery ImportSourceCredentials

Defined in Amazonka.CodeBuild.ImportSourceCredentials

Methods

toQuery :: ImportSourceCredentials -> QueryString

AWSRequest ImportSourceCredentials

Defined in Amazonka.CodeBuild.ImportSourceCredentials

Associated Types

type AWSResponse ImportSourceCredentials

Methods

request :: (Service -> Service) -> ImportSourceCredentials -> Request ImportSourceCredentials

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ImportSourceCredentials -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ImportSourceCredentials)))

Generic ImportSourceCredentials

Defined in Amazonka.CodeBuild.ImportSourceCredentials

Associated Types

type Rep ImportSourceCredentials :: Type -> Type

Methods

from :: ImportSourceCredentials -> Rep ImportSourceCredentials x

to :: Rep ImportSourceCredentials x -> ImportSourceCredentials

Show ImportSourceCredentials

Defined in Amazonka.CodeBuild.ImportSourceCredentials

Methods

showsPrec :: Int -> ImportSourceCredentials -> ShowS

show :: ImportSourceCredentials -> String

showList :: [ImportSourceCredentials] -> ShowS

NFData ImportSourceCredentials

Defined in Amazonka.CodeBuild.ImportSourceCredentials

Methods

rnf :: ImportSourceCredentials -> ()

Eq ImportSourceCredentials

Defined in Amazonka.CodeBuild.ImportSourceCredentials

Methods

(==) :: ImportSourceCredentials -> ImportSourceCredentials -> Bool

(/=) :: ImportSourceCredentials -> ImportSourceCredentials -> Bool

Hashable ImportSourceCredentials

Defined in Amazonka.CodeBuild.ImportSourceCredentials

Methods

hashWithSalt :: Int -> ImportSourceCredentials -> Int

hash :: ImportSourceCredentials -> Int

type AWSResponse ImportSourceCredentials

Defined in Amazonka.CodeBuild.ImportSourceCredentials

type AWSResponse ImportSourceCredentials = ImportSourceCredentialsResponse

type Rep ImportSourceCredentials

Defined in Amazonka.CodeBuild.ImportSourceCredentials

type Rep ImportSourceCredentials = D1 ('MetaData "ImportSourceCredentials" "Amazonka.CodeBuild.ImportSourceCredentials" "amazonka-codebuild-2.0-3KpZspRk9Ul8Wu4D0cM13Q" 'False) (C1 ('MetaCons "ImportSourceCredentials'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "shouldOverwrite") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: (S1 ('MetaSel ('Just "serverType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ServerType) :*: S1 ('MetaSel ('Just "authType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AuthType)))))

newImportSourceCredentials

Arguments

:: Text

$sel:token:ImportSourceCredentials'

-> ServerType

ImportSourceCredentials

-> AuthType

ImportSourceCredentials

-> ImportSourceCredentials

Create a value of ImportSourceCredentials with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:shouldOverwrite:ImportSourceCredentials', importSourceCredentials_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.

$sel:username:ImportSourceCredentials', importSourceCredentials_username - The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections.

$sel:token:ImportSourceCredentials', importSourceCredentials_token - For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password.

ImportSourceCredentials, importSourceCredentials_serverType - The source provider used for this project.

ImportSourceCredentials, importSourceCredentials_authType - 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 CodeBuild console.

Request Lenses

importSourceCredentials_shouldOverwrite :: Lens' ImportSourceCredentials (Maybe Bool)

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

importSourceCredentials_username :: Lens' ImportSourceCredentials (Maybe Text)

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

importSourceCredentials_token :: Lens' ImportSourceCredentials Text

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

importSourceCredentials_serverType :: Lens' ImportSourceCredentials ServerType

The source provider used for this project.

importSourceCredentials_authType :: Lens' ImportSourceCredentials AuthType

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 CodeBuild console.

Destructuring the Response

data ImportSourceCredentialsResponse

See: newImportSourceCredentialsResponse smart constructor.

Constructors

ImportSourceCredentialsResponse'

Fields

• arn :: Maybe Text

  The Amazon Resource Name (ARN) of the token.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ImportSourceCredentialsResponse

Defined in Amazonka.CodeBuild.ImportSourceCredentials

Associated Types

type Rep ImportSourceCredentialsResponse :: Type -> Type

Methods

from :: ImportSourceCredentialsResponse -> Rep ImportSourceCredentialsResponse x

to :: Rep ImportSourceCredentialsResponse x -> ImportSourceCredentialsResponse

Read ImportSourceCredentialsResponse

Defined in Amazonka.CodeBuild.ImportSourceCredentials

Methods

readsPrec :: Int -> ReadS ImportSourceCredentialsResponse

readList :: ReadS [ImportSourceCredentialsResponse]

readPrec :: ReadPrec ImportSourceCredentialsResponse

readListPrec :: ReadPrec [ImportSourceCredentialsResponse]

Show ImportSourceCredentialsResponse

Defined in Amazonka.CodeBuild.ImportSourceCredentials

Methods

showsPrec :: Int -> ImportSourceCredentialsResponse -> ShowS

show :: ImportSourceCredentialsResponse -> String

showList :: [ImportSourceCredentialsResponse] -> ShowS

NFData ImportSourceCredentialsResponse

Defined in Amazonka.CodeBuild.ImportSourceCredentials

Methods

rnf :: ImportSourceCredentialsResponse -> ()

Eq ImportSourceCredentialsResponse

Defined in Amazonka.CodeBuild.ImportSourceCredentials

Methods

(==) :: ImportSourceCredentialsResponse -> ImportSourceCredentialsResponse -> Bool

(/=) :: ImportSourceCredentialsResponse -> ImportSourceCredentialsResponse -> Bool

type Rep ImportSourceCredentialsResponse

Defined in Amazonka.CodeBuild.ImportSourceCredentials

type Rep ImportSourceCredentialsResponse = D1 ('MetaData "ImportSourceCredentialsResponse" "Amazonka.CodeBuild.ImportSourceCredentials" "amazonka-codebuild-2.0-3KpZspRk9Ul8Wu4D0cM13Q" 'False) (C1 ('MetaCons "ImportSourceCredentialsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newImportSourceCredentialsResponse

Arguments

:: Int

$sel:httpStatus:ImportSourceCredentialsResponse'

-> ImportSourceCredentialsResponse

Create a value of ImportSourceCredentialsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ImportSourceCredentialsResponse, importSourceCredentialsResponse_arn - The Amazon Resource Name (ARN) of the token.

$sel:httpStatus:ImportSourceCredentialsResponse', importSourceCredentialsResponse_httpStatus - The response's http status code.

Response Lenses

importSourceCredentialsResponse_arn :: Lens' ImportSourceCredentialsResponse (Maybe Text)

The Amazon Resource Name (ARN) of the token.

importSourceCredentialsResponse_httpStatus :: Lens' ImportSourceCredentialsResponse Int

The response's http status code.