Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Creates a build project.
Synopsis
- data CreateProject = CreateProject' {
- badgeEnabled :: Maybe Bool
- buildBatchConfig :: Maybe ProjectBuildBatchConfig
- cache :: Maybe ProjectCache
- concurrentBuildLimit :: Maybe Int
- description :: Maybe Text
- encryptionKey :: Maybe Text
- fileSystemLocations :: Maybe [ProjectFileSystemLocation]
- logsConfig :: Maybe LogsConfig
- queuedTimeoutInMinutes :: Maybe Natural
- secondaryArtifacts :: Maybe [ProjectArtifacts]
- secondarySourceVersions :: Maybe [ProjectSourceVersion]
- secondarySources :: Maybe [ProjectSource]
- sourceVersion :: Maybe Text
- tags :: Maybe [Tag]
- timeoutInMinutes :: Maybe Natural
- vpcConfig :: Maybe VpcConfig
- name :: Text
- source :: ProjectSource
- artifacts :: ProjectArtifacts
- environment :: ProjectEnvironment
- serviceRole :: Text
- newCreateProject :: Text -> ProjectSource -> ProjectArtifacts -> ProjectEnvironment -> Text -> CreateProject
- createProject_badgeEnabled :: Lens' CreateProject (Maybe Bool)
- createProject_buildBatchConfig :: Lens' CreateProject (Maybe ProjectBuildBatchConfig)
- createProject_cache :: Lens' CreateProject (Maybe ProjectCache)
- createProject_concurrentBuildLimit :: Lens' CreateProject (Maybe Int)
- createProject_description :: Lens' CreateProject (Maybe Text)
- createProject_encryptionKey :: Lens' CreateProject (Maybe Text)
- createProject_fileSystemLocations :: Lens' CreateProject (Maybe [ProjectFileSystemLocation])
- createProject_logsConfig :: Lens' CreateProject (Maybe LogsConfig)
- createProject_queuedTimeoutInMinutes :: Lens' CreateProject (Maybe Natural)
- createProject_secondaryArtifacts :: Lens' CreateProject (Maybe [ProjectArtifacts])
- createProject_secondarySourceVersions :: Lens' CreateProject (Maybe [ProjectSourceVersion])
- createProject_secondarySources :: Lens' CreateProject (Maybe [ProjectSource])
- createProject_sourceVersion :: Lens' CreateProject (Maybe Text)
- createProject_tags :: Lens' CreateProject (Maybe [Tag])
- createProject_timeoutInMinutes :: Lens' CreateProject (Maybe Natural)
- createProject_vpcConfig :: Lens' CreateProject (Maybe VpcConfig)
- createProject_name :: Lens' CreateProject Text
- createProject_source :: Lens' CreateProject ProjectSource
- createProject_artifacts :: Lens' CreateProject ProjectArtifacts
- createProject_environment :: Lens' CreateProject ProjectEnvironment
- createProject_serviceRole :: Lens' CreateProject Text
- data CreateProjectResponse = CreateProjectResponse' {
- project :: Maybe Project
- httpStatus :: Int
- newCreateProjectResponse :: Int -> CreateProjectResponse
- createProjectResponse_project :: Lens' CreateProjectResponse (Maybe Project)
- createProjectResponse_httpStatus :: Lens' CreateProjectResponse Int
Creating a Request
data CreateProject Source #
See: newCreateProject
smart constructor.
CreateProject' | |
|
Instances
:: Text | |
-> ProjectSource | |
-> ProjectArtifacts | |
-> ProjectEnvironment | |
-> Text | |
-> CreateProject |
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 examplepr/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_secondaryArtifacts :: Lens' CreateProject (Maybe [ProjectArtifacts]) Source #
An array of ProjectArtifacts
objects.
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_secondarySources :: Lens' CreateProject (Maybe [ProjectSource]) Source #
An array of ProjectSource
objects.
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 examplepr/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.
CreateProjectResponse' | |
|
Instances
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.
createProjectResponse_httpStatus :: Lens' CreateProjectResponse Int Source #
The response's http status code.