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.CreateProject

Description

Creates a build project.

Synopsis

Creating a Request

data CreateProject Source #

See: newCreateProject smart constructor.

Constructors

CreateProject' 

Fields

  • badgeEnabled :: Maybe Bool

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

  • buildBatchConfig :: Maybe ProjectBuildBatchConfig

    A ProjectBuildBatchConfig object that defines the batch build options for the project.

  • 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.

  • description :: Maybe Text

    A description that makes the build project easy to identify.

  • 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>).

  • 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. These can be logs in CloudWatch Logs, logs uploaded to a specified 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 ProjectArtifacts objects.

  • secondarySourceVersions :: Maybe [ProjectSourceVersion]

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

  • secondarySources :: Maybe [ProjectSource]

    An array of ProjectSource objects.

  • 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]

    A 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

    How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes.

  • vpcConfig :: Maybe VpcConfig

    VpcConfig enables CodeBuild to access resources in an Amazon VPC.

  • name :: Text

    The name of the build project.

  • source :: ProjectSource

    Information about the build input source code for the build project.

  • artifacts :: ProjectArtifacts

    Information about the build output artifacts for the build project.

  • environment :: ProjectEnvironment

    Information about the build environment for the build project.

  • serviceRole :: Text

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

Instances

Instances details
ToJSON CreateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.CreateProject

ToHeaders CreateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.CreateProject

ToPath CreateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.CreateProject

ToQuery CreateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.CreateProject

AWSRequest CreateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.CreateProject

Associated Types

type AWSResponse CreateProject #

Generic CreateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.CreateProject

Associated Types

type Rep CreateProject :: Type -> Type #

Read CreateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.CreateProject

Show CreateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.CreateProject

NFData CreateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.CreateProject

Methods

rnf :: CreateProject -> () #

Eq CreateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.CreateProject

Hashable CreateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.CreateProject

type AWSResponse CreateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.CreateProject

type Rep CreateProject Source # 
Instance details

Defined in Amazonka.CodeBuild.CreateProject

type Rep CreateProject = D1 ('MetaData "CreateProject" "Amazonka.CodeBuild.CreateProject" "amazonka-codebuild-2.0-3KpZspRk9Ul8Wu4D0cM13Q" 'False) (C1 ('MetaCons "CreateProject'" 'PrefixI 'True) ((((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 "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 "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) :*: S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProjectSource))) :*: (S1 ('MetaSel ('Just "artifacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProjectArtifacts) :*: (S1 ('MetaSel ('Just "environment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProjectEnvironment) :*: S1 ('MetaSel ('Just "serviceRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newCreateProject Source #

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

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

CreateProject, createProject_buildBatchConfig - A ProjectBuildBatchConfig object that defines the batch build options for the project.

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

CreateProject, createProject_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.

CreateProject, createProject_description - A description that makes the build project easy to identify.

CreateProject, createProject_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>).

CreateProject, createProject_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.

CreateProject, createProject_logsConfig - Information about logs for the build project. These can be logs in CloudWatch Logs, logs uploaded to a specified S3 bucket, or both.

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

CreateProject, createProject_secondaryArtifacts - An array of ProjectArtifacts objects.

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

CreateProject, createProject_secondarySources - An array of ProjectSource objects.

CreateProject, createProject_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.

CreateProject, createProject_tags - A 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.

CreateProject, createProject_timeoutInMinutes - How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes.

CreateProject, createProject_vpcConfig - VpcConfig enables CodeBuild to access resources in an Amazon VPC.

CreateProject, createProject_name - The name of the build project.

CreateProject, createProject_source - Information about the build input source code for the build project.

CreateProject, createProject_artifacts - Information about the build output artifacts for the build project.

CreateProject, createProject_environment - Information about the build environment for the build project.

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

Request Lenses

createProject_badgeEnabled :: Lens' CreateProject (Maybe Bool) Source #

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

createProject_buildBatchConfig :: Lens' CreateProject (Maybe ProjectBuildBatchConfig) Source #

A ProjectBuildBatchConfig object that defines the batch build options for the project.

createProject_cache :: Lens' CreateProject (Maybe ProjectCache) Source #

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

createProject_concurrentBuildLimit :: Lens' CreateProject (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.

createProject_description :: Lens' CreateProject (Maybe Text) Source #

A description that makes the build project easy to identify.

createProject_encryptionKey :: Lens' CreateProject (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>).

createProject_fileSystemLocations :: Lens' CreateProject (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.

createProject_logsConfig :: Lens' CreateProject (Maybe LogsConfig) Source #

Information about logs for the build project. These can be logs in CloudWatch Logs, logs uploaded to a specified S3 bucket, or both.

createProject_queuedTimeoutInMinutes :: Lens' CreateProject (Maybe Natural) Source #

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

createProject_secondarySourceVersions :: Lens' CreateProject (Maybe [ProjectSourceVersion]) Source #

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

createProject_sourceVersion :: Lens' CreateProject (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.

createProject_tags :: Lens' CreateProject (Maybe [Tag]) Source #

A 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.

createProject_timeoutInMinutes :: Lens' CreateProject (Maybe Natural) Source #

How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes.

createProject_vpcConfig :: Lens' CreateProject (Maybe VpcConfig) Source #

VpcConfig enables CodeBuild to access resources in an Amazon VPC.

createProject_name :: Lens' CreateProject Text Source #

The name of the build project.

createProject_source :: Lens' CreateProject ProjectSource Source #

Information about the build input source code for the build project.

createProject_artifacts :: Lens' CreateProject ProjectArtifacts Source #

Information about the build output artifacts for the build project.

createProject_environment :: Lens' CreateProject ProjectEnvironment Source #

Information about the build environment for the build project.

createProject_serviceRole :: Lens' CreateProject Text Source #

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

Destructuring the Response

data CreateProjectResponse Source #

See: newCreateProjectResponse smart constructor.

Constructors

CreateProjectResponse' 

Fields

Instances

Instances details
Generic CreateProjectResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.CreateProject

Associated Types

type Rep CreateProjectResponse :: Type -> Type #

Read CreateProjectResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.CreateProject

Show CreateProjectResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.CreateProject

NFData CreateProjectResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.CreateProject

Methods

rnf :: CreateProjectResponse -> () #

Eq CreateProjectResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.CreateProject

type Rep CreateProjectResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.CreateProject

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

newCreateProjectResponse Source #

Create a value of CreateProjectResponse 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:CreateProjectResponse', createProjectResponse_project - Information about the build project that was created.

$sel:httpStatus:CreateProjectResponse', createProjectResponse_httpStatus - The response's http status code.

Response Lenses

createProjectResponse_project :: Lens' CreateProjectResponse (Maybe Project) Source #

Information about the build project that was created.