amazonka-codebuild-2.0: Amazon CodeBuild SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CodeBuild.UpdateProject

Description

Changes the settings of a build project.

Synopsis

Creating a Request

data UpdateProject Source #

See: newUpdateProject smart constructor.

Constructors

UpdateProject' 

Fields

  • artifacts :: Maybe ProjectArtifacts

    Information to be changed about the build output artifacts for the build project.

  • badgeEnabled :: Maybe Bool

    Set this to true to generate a publicly accessible URL for your project's build badge.

  • buildBatchConfig :: Maybe ProjectBuildBatchConfig
     
  • cache :: Maybe ProjectCache

    Stores recently used information so that it can be quickly accessed at a later time.

  • concurrentBuildLimit :: Maybe Int

    The maximum number of concurrent builds that are allowed for this project.

    New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.

    To remove this limit, set this value to -1.

  • description :: Maybe Text

    A new or replacement description of the build project.

  • encryptionKey :: Maybe Text

    The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

    You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

    You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

  • environment :: Maybe ProjectEnvironment

    Information to be changed about the build environment for the build project.

  • fileSystemLocations :: Maybe [ProjectFileSystemLocation]

    An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

  • logsConfig :: Maybe LogsConfig

    Information about logs for the build project. A project can create logs in CloudWatch Logs, logs in an S3 bucket, or both.

  • queuedTimeoutInMinutes :: Maybe Natural

    The number of minutes a build is allowed to be queued before it times out.

  • secondaryArtifacts :: Maybe [ProjectArtifacts]

    An array of ProjectArtifact objects.

  • secondarySourceVersions :: Maybe [ProjectSourceVersion]

    An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).

  • secondarySources :: Maybe [ProjectSource]

    An array of ProjectSource objects.

  • serviceRole :: Maybe Text

    The replacement ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.

  • source :: Maybe ProjectSource

    Information to be changed about the build input source code for the build project.

  • sourceVersion :: Maybe Text

    A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:

    • For CodeCommit: the commit ID, branch, or Git tag to use.
    • For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
    • For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
    • For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

    If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).

    For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

  • tags :: Maybe [Tag]

    An updated list of tag key and value pairs associated with this build project.

    These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.

  • timeoutInMinutes :: Maybe Natural

    The replacement value in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed.

  • vpcConfig :: Maybe VpcConfig

    VpcConfig enables CodeBuild to access resources in an Amazon VPC.

  • name :: Text

    The name of the build project.

    You cannot change a build project's name.

Instances

Instances details
ToJSON UpdateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProject

ToHeaders UpdateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProject

ToPath UpdateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProject

ToQuery UpdateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProject

AWSRequest UpdateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProject

Associated Types

type AWSResponse UpdateProject #

Generic UpdateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProject

Associated Types

type Rep UpdateProject :: Type -> Type #

Read UpdateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProject

Show UpdateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProject

NFData UpdateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProject

Methods

rnf :: UpdateProject -> () #

Eq UpdateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProject

Hashable UpdateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProject

type AWSResponse UpdateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProject

type Rep UpdateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProject

type Rep UpdateProject = D1 ('MetaData "UpdateProject" "Amazonka.CodeBuild.UpdateProject" "amazonka-codebuild-2.0-3KpZspRk9Ul8Wu4D0cM13Q" 'False) (C1 ('MetaCons "UpdateProject'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "artifacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProjectArtifacts)) :*: S1 ('MetaSel ('Just "badgeEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "buildBatchConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProjectBuildBatchConfig)) :*: (S1 ('MetaSel ('Just "cache") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProjectCache)) :*: S1 ('MetaSel ('Just "concurrentBuildLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :*: ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "encryptionKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "environment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProjectEnvironment)) :*: (S1 ('MetaSel ('Just "fileSystemLocations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProjectFileSystemLocation])) :*: S1 ('MetaSel ('Just "logsConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogsConfig)))))) :*: (((S1 ('MetaSel ('Just "queuedTimeoutInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "secondaryArtifacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProjectArtifacts]))) :*: (S1 ('MetaSel ('Just "secondarySourceVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProjectSourceVersion])) :*: (S1 ('MetaSel ('Just "secondarySources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProjectSource])) :*: S1 ('MetaSel ('Just "serviceRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProjectSource)) :*: (S1 ('MetaSel ('Just "sourceVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :*: (S1 ('MetaSel ('Just "timeoutInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "vpcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfig)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newUpdateProject Source #

Create a value of UpdateProject 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:

UpdateProject, updateProject_artifacts - Information to be changed about the build output artifacts for the build project.

UpdateProject, updateProject_badgeEnabled - Set this to true to generate a publicly accessible URL for your project's build badge.

UpdateProject, updateProject_buildBatchConfig - Undocumented member.

UpdateProject, updateProject_cache - Stores recently used information so that it can be quickly accessed at a later time.

UpdateProject, updateProject_concurrentBuildLimit - The maximum number of concurrent builds that are allowed for this project.

New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.

To remove this limit, set this value to -1.

UpdateProject, updateProject_description - A new or replacement description of the build project.

UpdateProject, updateProject_encryptionKey - The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

UpdateProject, updateProject_environment - Information to be changed about the build environment for the build project.

UpdateProject, updateProject_fileSystemLocations - An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

UpdateProject, updateProject_logsConfig - Information about logs for the build project. A project can create logs in CloudWatch Logs, logs in an S3 bucket, or both.

UpdateProject, updateProject_queuedTimeoutInMinutes - The number of minutes a build is allowed to be queued before it times out.

UpdateProject, updateProject_secondaryArtifacts - An array of ProjectArtifact objects.

UpdateProject, updateProject_secondarySourceVersions - An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).

UpdateProject, updateProject_secondarySources - An array of ProjectSource objects.

UpdateProject, updateProject_serviceRole - The replacement ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.

UpdateProject, updateProject_source - Information to be changed about the build input source code for the build project.

UpdateProject, updateProject_sourceVersion - A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:

  • For CodeCommit: the commit ID, branch, or Git tag to use.
  • For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
  • For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
  • For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

UpdateProject, updateProject_tags - An updated list of tag key and value pairs associated with this build project.

These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.

UpdateProject, updateProject_timeoutInMinutes - The replacement value in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed.

UpdateProject, updateProject_vpcConfig - VpcConfig enables CodeBuild to access resources in an Amazon VPC.

UpdateProject, updateProject_name - The name of the build project.

You cannot change a build project's name.

Request Lenses

updateProject_artifacts :: Lens' UpdateProject (Maybe ProjectArtifacts) Source #

Information to be changed about the build output artifacts for the build project.

updateProject_badgeEnabled :: Lens' UpdateProject (Maybe Bool) Source #

Set this to true to generate a publicly accessible URL for your project's build badge.

updateProject_cache :: Lens' UpdateProject (Maybe ProjectCache) Source #

Stores recently used information so that it can be quickly accessed at a later time.

updateProject_concurrentBuildLimit :: Lens' UpdateProject (Maybe Int) Source #

The maximum number of concurrent builds that are allowed for this project.

New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.

To remove this limit, set this value to -1.

updateProject_description :: Lens' UpdateProject (Maybe Text) Source #

A new or replacement description of the build project.

updateProject_encryptionKey :: Lens' UpdateProject (Maybe Text) Source #

The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

updateProject_environment :: Lens' UpdateProject (Maybe ProjectEnvironment) Source #

Information to be changed about the build environment for the build project.

updateProject_fileSystemLocations :: Lens' UpdateProject (Maybe [ProjectFileSystemLocation]) Source #

An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

updateProject_logsConfig :: Lens' UpdateProject (Maybe LogsConfig) Source #

Information about logs for the build project. A project can create logs in CloudWatch Logs, logs in an S3 bucket, or both.

updateProject_queuedTimeoutInMinutes :: Lens' UpdateProject (Maybe Natural) Source #

The number of minutes a build is allowed to be queued before it times out.

updateProject_secondarySourceVersions :: Lens' UpdateProject (Maybe [ProjectSourceVersion]) Source #

An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).

updateProject_serviceRole :: Lens' UpdateProject (Maybe Text) Source #

The replacement ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.

updateProject_source :: Lens' UpdateProject (Maybe ProjectSource) Source #

Information to be changed about the build input source code for the build project.

updateProject_sourceVersion :: Lens' UpdateProject (Maybe Text) Source #

A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:

  • For CodeCommit: the commit ID, branch, or Git tag to use.
  • For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
  • For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
  • For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

updateProject_tags :: Lens' UpdateProject (Maybe [Tag]) Source #

An updated list of tag key and value pairs associated with this build project.

These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.

updateProject_timeoutInMinutes :: Lens' UpdateProject (Maybe Natural) Source #

The replacement value in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed.

updateProject_vpcConfig :: Lens' UpdateProject (Maybe VpcConfig) Source #

VpcConfig enables CodeBuild to access resources in an Amazon VPC.

updateProject_name :: Lens' UpdateProject Text Source #

The name of the build project.

You cannot change a build project's name.

Destructuring the Response

data UpdateProjectResponse Source #

See: newUpdateProjectResponse smart constructor.

Constructors

UpdateProjectResponse' 

Fields

Instances

Instances details
Generic UpdateProjectResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProject

Associated Types

type Rep UpdateProjectResponse :: Type -> Type #

Read UpdateProjectResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProject

Show UpdateProjectResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProject

NFData UpdateProjectResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProject

Methods

rnf :: UpdateProjectResponse -> () #

Eq UpdateProjectResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProject

type Rep UpdateProjectResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProject

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

newUpdateProjectResponse Source #

Create a value of UpdateProjectResponse 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:project:UpdateProjectResponse', updateProjectResponse_project - Information about the build project that was changed.

$sel:httpStatus:UpdateProjectResponse', updateProjectResponse_httpStatus - The response's http status code.

Response Lenses

updateProjectResponse_project :: Lens' UpdateProjectResponse (Maybe Project) Source #

Information about the build project that was changed.