Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Amazonka.CodeBuild.ImportSourceCredentials
Description
Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.
Synopsis
- data ImportSourceCredentials = ImportSourceCredentials' {}
- newImportSourceCredentials :: Text -> ServerType -> AuthType -> ImportSourceCredentials
- importSourceCredentials_username :: Lens' ImportSourceCredentials (Maybe Text)
- importSourceCredentials_shouldOverwrite :: Lens' ImportSourceCredentials (Maybe Bool)
- importSourceCredentials_token :: Lens' ImportSourceCredentials Text
- importSourceCredentials_serverType :: Lens' ImportSourceCredentials ServerType
- importSourceCredentials_authType :: Lens' ImportSourceCredentials AuthType
- data ImportSourceCredentialsResponse = ImportSourceCredentialsResponse' {
- arn :: Maybe Text
- httpStatus :: Int
- newImportSourceCredentialsResponse :: Int -> ImportSourceCredentialsResponse
- importSourceCredentialsResponse_arn :: Lens' ImportSourceCredentialsResponse (Maybe Text)
- importSourceCredentialsResponse_httpStatus :: Lens' ImportSourceCredentialsResponse Int
Creating a Request
data ImportSourceCredentials Source #
See: newImportSourceCredentials
smart constructor.
Constructors
ImportSourceCredentials' | |
Fields
|
Instances
newImportSourceCredentials Source #
Arguments
:: Text | |
-> ServerType | |
-> AuthType | |
-> 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: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: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:token:ImportSourceCredentials'
, importSourceCredentials_token
- For GitHub or GitHub Enterprise, this is the personal access token. For
Bitbucket, this is the app password.
$sel:serverType:ImportSourceCredentials'
, importSourceCredentials_serverType
- The source provider used for this project.
$sel:authType: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_username :: Lens' ImportSourceCredentials (Maybe Text) Source #
The Bitbucket username when the authType
is BASIC_AUTH. This parameter
is not valid for other types of source providers or connections.
importSourceCredentials_shouldOverwrite :: Lens' ImportSourceCredentials (Maybe Bool) Source #
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_token :: Lens' ImportSourceCredentials Text Source #
For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password.
importSourceCredentials_serverType :: Lens' ImportSourceCredentials ServerType Source #
The source provider used for this project.
importSourceCredentials_authType :: Lens' ImportSourceCredentials AuthType Source #
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 Source #
See: newImportSourceCredentialsResponse
smart constructor.
Constructors
ImportSourceCredentialsResponse' | |
Fields
|
Instances
newImportSourceCredentialsResponse Source #
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:
$sel:arn: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) Source #
The Amazon Resource Name (ARN) of the token.
importSourceCredentialsResponse_httpStatus :: Lens' ImportSourceCredentialsResponse Int Source #
The response's http status code.