We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
Resource type definition for AWS::CodeBuild::Project
Using getProject
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getProject(args: GetProjectArgs, opts?: InvokeOptions): Promise<GetProjectResult>
function getProjectOutput(args: GetProjectOutputArgs, opts?: InvokeOutputOptions): Output<GetProjectResult>def get_project(name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetProjectResult
def get_project_output(name: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetProjectResult]func LookupProject(ctx *Context, args *LookupProjectArgs, opts ...InvokeOption) (*LookupProjectResult, error)
func LookupProjectOutput(ctx *Context, args *LookupProjectOutputArgs, opts ...InvokeOption) LookupProjectResultOutput> Note: This function is named LookupProject in the Go SDK.
public static class GetProject
{
public static Task<GetProjectResult> InvokeAsync(GetProjectArgs args, InvokeOptions? opts = null)
public static Output<GetProjectResult> Invoke(GetProjectInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetProjectResult> Invoke(GetProjectInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
public static Output<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
public static Output<GetProjectResult> getProject(GetProjectArgs args, InvokeOutputOptions options)
fn::invoke:
function: aws-native:codebuild:getProject
arguments:
# arguments dictionarydata "aws-native_codebuild_get_project" "name" {
# arguments
}The following arguments are supported:
- Name string
- The name of the build project. The name must be unique across all of the projects in your AWS account .
- Name string
- The name of the build project. The name must be unique across all of the projects in your AWS account .
- name string
- The name of the build project. The name must be unique across all of the projects in your AWS account .
- name String
- The name of the build project. The name must be unique across all of the projects in your AWS account .
- name string
- The name of the build project. The name must be unique across all of the projects in your AWS account .
- name str
- The name of the build project. The name must be unique across all of the projects in your AWS account .
- name String
- The name of the build project. The name must be unique across all of the projects in your AWS account .
getProject Result
The following output properties are available:
- Arn string
- The ARN of the AWS CodeBuild project, such as
arn:aws:codebuild:us-west-2:123456789012:project/myProjectName. - Artifacts
Pulumi.
Aws Native. Code Build. Outputs. Project Artifacts - Specifies output settings for artifacts generated by an AWS CodeBuild build.
- Auto
Retry intLimit - Badge
Enabled bool - Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.
- Build
Batch Pulumi.Config Aws Native. Code Build. Outputs. Project Build Batch Config - Defines the batch build options for the project.
- Cache
Pulumi.
Aws Native. Code Build. Outputs. Project Cache - Settings that AWS CodeBuild uses to store and reuse build dependencies.
- Concurrent
Build intLimit - The maximum number of concurrent builds that are allowed for this project.
- Description string
- A description that makes the build project easy to identify.
- Encryption
Key string The AWS 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>). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).- Environment
Pulumi.
Aws Native. Code Build. Outputs. Project Environment - The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.
- File
System List<Pulumi.Locations Aws Native. Code Build. Outputs. Project File System Location> - An array of
ProjectFileSystemLocationobjects for a CodeBuild build project. AProjectFileSystemLocationobject specifies theidentifier,location,mountOptions,mountPoint, andtypeof a file system created using Amazon Elastic File System. - Logs
Config Pulumi.Aws Native. Code Build. Outputs. Project Logs Config - Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both.
- Queued
Timeout intIn Minutes - The number of minutes a build is allowed to be queued before it times out.
- Resource
Access stringRole - The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.
- Secondary
Artifacts List<Pulumi.Aws Native. Code Build. Outputs. Project Artifacts> - A list of
Artifactsobjects. Each artifacts object specifies output settings that the project generates during a build. - Secondary
Source List<Pulumi.Versions Aws Native. Code Build. Outputs. Project Source Version> - An array of
ProjectSourceVersionobjects. IfsecondarySourceVersionsis specified at the build level, then they take over thesesecondarySourceVersions(at the project level). - Secondary
Sources List<Pulumi.Aws Native. Code Build. Outputs. Project Source> - An array of
ProjectSourceobjects. - Service
Role string - The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
- Source
Pulumi.
Aws Native. Code Build. Outputs. Project Source - The source code settings for the project, such as the source code's repository type and location.
- Source
Version string 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 GitLab: the commit ID, branch, or Git tag to use.
- 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
sourceVersionis specified at the build level, then that version takes precedence over thissourceVersion(at the project level).For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide .
-
List<Pulumi.
Aws Native. Outputs. Tag> An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.
These tags are available for use by AWS services that support AWS CodeBuild build project tags.
- Timeout
In intMinutes - How long, in minutes, from 5 to 2160 (36 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.
- Visibility string
- Specifies the visibility of the project's builds. Possible values are:
- PUBLIC_READ - The project builds are visible to the public.
- PRIVATE - The project builds are not visible to the public.
- Vpc
Config Pulumi.Aws Native. Code Build. Outputs. Project Vpc Config VpcConfigspecifies settings that enable AWS CodeBuild to access resources in an Amazon VPC. For more information, see Use AWS CodeBuild with Amazon Virtual Private Cloud in the AWS CodeBuild User Guide .
- Arn string
- The ARN of the AWS CodeBuild project, such as
arn:aws:codebuild:us-west-2:123456789012:project/myProjectName. - Artifacts
Project
Artifacts - Specifies output settings for artifacts generated by an AWS CodeBuild build.
- Auto
Retry intLimit - Badge
Enabled bool - Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.
- Build
Batch ProjectConfig Build Batch Config - Defines the batch build options for the project.
- Cache
Project
Cache - Settings that AWS CodeBuild uses to store and reuse build dependencies.
- Concurrent
Build intLimit - The maximum number of concurrent builds that are allowed for this project.
- Description string
- A description that makes the build project easy to identify.
- Encryption
Key string The AWS 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>). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).- Environment
Project
Environment - The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.
- File
System []ProjectLocations File System Location - An array of
ProjectFileSystemLocationobjects for a CodeBuild build project. AProjectFileSystemLocationobject specifies theidentifier,location,mountOptions,mountPoint, andtypeof a file system created using Amazon Elastic File System. - Logs
Config ProjectLogs Config - Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both.
- Queued
Timeout intIn Minutes - The number of minutes a build is allowed to be queued before it times out.
- Resource
Access stringRole - The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.
- Secondary
Artifacts []ProjectArtifacts - A list of
Artifactsobjects. Each artifacts object specifies output settings that the project generates during a build. - Secondary
Source []ProjectVersions Source Version - An array of
ProjectSourceVersionobjects. IfsecondarySourceVersionsis specified at the build level, then they take over thesesecondarySourceVersions(at the project level). - Secondary
Sources []ProjectSource - An array of
ProjectSourceobjects. - Service
Role string - The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
- Source
Project
Source - The source code settings for the project, such as the source code's repository type and location.
- Source
Version string 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 GitLab: the commit ID, branch, or Git tag to use.
- 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
sourceVersionis specified at the build level, then that version takes precedence over thissourceVersion(at the project level).For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide .
- Tag
An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.
These tags are available for use by AWS services that support AWS CodeBuild build project tags.
- Timeout
In intMinutes - How long, in minutes, from 5 to 2160 (36 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.
- Visibility string
- Specifies the visibility of the project's builds. Possible values are:
- PUBLIC_READ - The project builds are visible to the public.
- PRIVATE - The project builds are not visible to the public.
- Vpc
Config ProjectVpc Config VpcConfigspecifies settings that enable AWS CodeBuild to access resources in an Amazon VPC. For more information, see Use AWS CodeBuild with Amazon Virtual Private Cloud in the AWS CodeBuild User Guide .
- arn string
- The ARN of the AWS CodeBuild project, such as
arn:aws:codebuild:us-west-2:123456789012:project/myProjectName. - artifacts object
- Specifies output settings for artifacts generated by an AWS CodeBuild build.
- auto_
retry_ numberlimit - badge_
enabled bool - Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.
- build_
batch_ objectconfig - Defines the batch build options for the project.
- cache object
- Settings that AWS CodeBuild uses to store and reuse build dependencies.
- concurrent_
build_ numberlimit - The maximum number of concurrent builds that are allowed for this project.
- description string
- A description that makes the build project easy to identify.
- encryption_
key string The AWS 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>). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).- environment object
- The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.
- file_
system_ list(object)locations - An array of
ProjectFileSystemLocationobjects for a CodeBuild build project. AProjectFileSystemLocationobject specifies theidentifier,location,mountOptions,mountPoint, andtypeof a file system created using Amazon Elastic File System. - logs_
config object - Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both.
- queued_
timeout_ numberin_ minutes - The number of minutes a build is allowed to be queued before it times out.
- resource_
access_ stringrole - The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.
- secondary_
artifacts list(object) - A list of
Artifactsobjects. Each artifacts object specifies output settings that the project generates during a build. - secondary_
source_ list(object)versions - An array of
ProjectSourceVersionobjects. IfsecondarySourceVersionsis specified at the build level, then they take over thesesecondarySourceVersions(at the project level). - secondary_
sources list(object) - An array of
ProjectSourceobjects. - service_
role string - The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
- source object
- The source code settings for the project, such as the source code's repository type and location.
- source_
version string 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 GitLab: the commit ID, branch, or Git tag to use.
- 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
sourceVersionis specified at the build level, then that version takes precedence over thissourceVersion(at the project level).For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide .
- list(object)
An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.
These tags are available for use by AWS services that support AWS CodeBuild build project tags.
- timeout_
in_ numberminutes - How long, in minutes, from 5 to 2160 (36 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.
- visibility string
- Specifies the visibility of the project's builds. Possible values are:
- PUBLIC_READ - The project builds are visible to the public.
- PRIVATE - The project builds are not visible to the public.
- vpc_
config object VpcConfigspecifies settings that enable AWS CodeBuild to access resources in an Amazon VPC. For more information, see Use AWS CodeBuild with Amazon Virtual Private Cloud in the AWS CodeBuild User Guide .
- arn String
- The ARN of the AWS CodeBuild project, such as
arn:aws:codebuild:us-west-2:123456789012:project/myProjectName. - artifacts
Project
Artifacts - Specifies output settings for artifacts generated by an AWS CodeBuild build.
- auto
Retry IntegerLimit - badge
Enabled Boolean - Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.
- build
Batch ProjectConfig Build Batch Config - Defines the batch build options for the project.
- cache
Project
Cache - Settings that AWS CodeBuild uses to store and reuse build dependencies.
- concurrent
Build IntegerLimit - The maximum number of concurrent builds that are allowed for this project.
- description String
- A description that makes the build project easy to identify.
- encryption
Key String The AWS 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>). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).- environment
Project
Environment - The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.
- file
System List<ProjectLocations File System Location> - An array of
ProjectFileSystemLocationobjects for a CodeBuild build project. AProjectFileSystemLocationobject specifies theidentifier,location,mountOptions,mountPoint, andtypeof a file system created using Amazon Elastic File System. - logs
Config ProjectLogs Config - Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both.
- queued
Timeout IntegerIn Minutes - The number of minutes a build is allowed to be queued before it times out.
- resource
Access StringRole - The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.
- secondary
Artifacts List<ProjectArtifacts> - A list of
Artifactsobjects. Each artifacts object specifies output settings that the project generates during a build. - secondary
Source List<ProjectVersions Source Version> - An array of
ProjectSourceVersionobjects. IfsecondarySourceVersionsis specified at the build level, then they take over thesesecondarySourceVersions(at the project level). - secondary
Sources List<ProjectSource> - An array of
ProjectSourceobjects. - service
Role String - The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
- source
Project
Source - The source code settings for the project, such as the source code's repository type and location.
- source
Version String 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 GitLab: the commit ID, branch, or Git tag to use.
- 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
sourceVersionis specified at the build level, then that version takes precedence over thissourceVersion(at the project level).For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide .
- List<Tag>
An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.
These tags are available for use by AWS services that support AWS CodeBuild build project tags.
- timeout
In IntegerMinutes - How long, in minutes, from 5 to 2160 (36 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.
- visibility String
- Specifies the visibility of the project's builds. Possible values are:
- PUBLIC_READ - The project builds are visible to the public.
- PRIVATE - The project builds are not visible to the public.
- vpc
Config ProjectVpc Config VpcConfigspecifies settings that enable AWS CodeBuild to access resources in an Amazon VPC. For more information, see Use AWS CodeBuild with Amazon Virtual Private Cloud in the AWS CodeBuild User Guide .
- arn string
- The ARN of the AWS CodeBuild project, such as
arn:aws:codebuild:us-west-2:123456789012:project/myProjectName. - artifacts
Project
Artifacts - Specifies output settings for artifacts generated by an AWS CodeBuild build.
- auto
Retry numberLimit - badge
Enabled boolean - Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.
- build
Batch ProjectConfig Build Batch Config - Defines the batch build options for the project.
- cache
Project
Cache - Settings that AWS CodeBuild uses to store and reuse build dependencies.
- concurrent
Build numberLimit - The maximum number of concurrent builds that are allowed for this project.
- description string
- A description that makes the build project easy to identify.
- encryption
Key string The AWS 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>). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).- environment
Project
Environment - The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.
- file
System ProjectLocations File System Location[] - An array of
ProjectFileSystemLocationobjects for a CodeBuild build project. AProjectFileSystemLocationobject specifies theidentifier,location,mountOptions,mountPoint, andtypeof a file system created using Amazon Elastic File System. - logs
Config ProjectLogs Config - Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both.
- queued
Timeout numberIn Minutes - The number of minutes a build is allowed to be queued before it times out.
- resource
Access stringRole - The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.
- secondary
Artifacts ProjectArtifacts[] - A list of
Artifactsobjects. Each artifacts object specifies output settings that the project generates during a build. - secondary
Source ProjectVersions Source Version[] - An array of
ProjectSourceVersionobjects. IfsecondarySourceVersionsis specified at the build level, then they take over thesesecondarySourceVersions(at the project level). - secondary
Sources ProjectSource[] - An array of
ProjectSourceobjects. - service
Role string - The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
- source
Project
Source - The source code settings for the project, such as the source code's repository type and location.
- source
Version string 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 GitLab: the commit ID, branch, or Git tag to use.
- 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
sourceVersionis specified at the build level, then that version takes precedence over thissourceVersion(at the project level).For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide .
- Tag[]
An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.
These tags are available for use by AWS services that support AWS CodeBuild build project tags.
- timeout
In numberMinutes - How long, in minutes, from 5 to 2160 (36 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.
- visibility string
- Specifies the visibility of the project's builds. Possible values are:
- PUBLIC_READ - The project builds are visible to the public.
- PRIVATE - The project builds are not visible to the public.
- vpc
Config ProjectVpc Config VpcConfigspecifies settings that enable AWS CodeBuild to access resources in an Amazon VPC. For more information, see Use AWS CodeBuild with Amazon Virtual Private Cloud in the AWS CodeBuild User Guide .
- arn str
- The ARN of the AWS CodeBuild project, such as
arn:aws:codebuild:us-west-2:123456789012:project/myProjectName. - artifacts
Project
Artifacts - Specifies output settings for artifacts generated by an AWS CodeBuild build.
- auto_
retry_ intlimit - badge_
enabled bool - Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.
- build_
batch_ Projectconfig Build Batch Config - Defines the batch build options for the project.
- cache
Project
Cache - Settings that AWS CodeBuild uses to store and reuse build dependencies.
- concurrent_
build_ intlimit - The maximum number of concurrent builds that are allowed for this project.
- description str
- A description that makes the build project easy to identify.
- encryption_
key str The AWS 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>). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).- environment
Project
Environment - The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.
- file_
system_ Sequence[Projectlocations File System Location] - An array of
ProjectFileSystemLocationobjects for a CodeBuild build project. AProjectFileSystemLocationobject specifies theidentifier,location,mountOptions,mountPoint, andtypeof a file system created using Amazon Elastic File System. - logs_
config ProjectLogs Config - Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both.
- queued_
timeout_ intin_ minutes - The number of minutes a build is allowed to be queued before it times out.
- resource_
access_ strrole - The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.
- secondary_
artifacts Sequence[ProjectArtifacts] - A list of
Artifactsobjects. Each artifacts object specifies output settings that the project generates during a build. - secondary_
source_ Sequence[Projectversions Source Version] - An array of
ProjectSourceVersionobjects. IfsecondarySourceVersionsis specified at the build level, then they take over thesesecondarySourceVersions(at the project level). - secondary_
sources Sequence[ProjectSource] - An array of
ProjectSourceobjects. - service_
role str - The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
- source
Project
Source - The source code settings for the project, such as the source code's repository type and location.
- source_
version str 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 GitLab: the commit ID, branch, or Git tag to use.
- 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
sourceVersionis specified at the build level, then that version takes precedence over thissourceVersion(at the project level).For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide .
- Sequence[root_Tag]
An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.
These tags are available for use by AWS services that support AWS CodeBuild build project tags.
- timeout_
in_ intminutes - How long, in minutes, from 5 to 2160 (36 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.
- visibility str
- Specifies the visibility of the project's builds. Possible values are:
- PUBLIC_READ - The project builds are visible to the public.
- PRIVATE - The project builds are not visible to the public.
- vpc_
config ProjectVpc Config VpcConfigspecifies settings that enable AWS CodeBuild to access resources in an Amazon VPC. For more information, see Use AWS CodeBuild with Amazon Virtual Private Cloud in the AWS CodeBuild User Guide .
- arn String
- The ARN of the AWS CodeBuild project, such as
arn:aws:codebuild:us-west-2:123456789012:project/myProjectName. - artifacts Property Map
- Specifies output settings for artifacts generated by an AWS CodeBuild build.
- auto
Retry NumberLimit - badge
Enabled Boolean - Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.
- build
Batch Property MapConfig - Defines the batch build options for the project.
- cache Property Map
- Settings that AWS CodeBuild uses to store and reuse build dependencies.
- concurrent
Build NumberLimit - The maximum number of concurrent builds that are allowed for this project.
- description String
- A description that makes the build project easy to identify.
- encryption
Key String The AWS 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>). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).- environment Property Map
- The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.
- file
System List<Property Map>Locations - An array of
ProjectFileSystemLocationobjects for a CodeBuild build project. AProjectFileSystemLocationobject specifies theidentifier,location,mountOptions,mountPoint, andtypeof a file system created using Amazon Elastic File System. - logs
Config Property Map - Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both.
- queued
Timeout NumberIn Minutes - The number of minutes a build is allowed to be queued before it times out.
- resource
Access StringRole - The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.
- secondary
Artifacts List<Property Map> - A list of
Artifactsobjects. Each artifacts object specifies output settings that the project generates during a build. - secondary
Source List<Property Map>Versions - An array of
ProjectSourceVersionobjects. IfsecondarySourceVersionsis specified at the build level, then they take over thesesecondarySourceVersions(at the project level). - secondary
Sources List<Property Map> - An array of
ProjectSourceobjects. - service
Role String - The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
- source Property Map
- The source code settings for the project, such as the source code's repository type and location.
- source
Version String 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 GitLab: the commit ID, branch, or Git tag to use.
- 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
sourceVersionis specified at the build level, then that version takes precedence over thissourceVersion(at the project level).For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide .
- List<Property Map>
An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.
These tags are available for use by AWS services that support AWS CodeBuild build project tags.
- timeout
In NumberMinutes - How long, in minutes, from 5 to 2160 (36 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.
- visibility String
- Specifies the visibility of the project's builds. Possible values are:
- PUBLIC_READ - The project builds are visible to the public.
- PRIVATE - The project builds are not visible to the public.
- vpc
Config Property Map VpcConfigspecifies settings that enable AWS CodeBuild to access resources in an Amazon VPC. For more information, see Use AWS CodeBuild with Amazon Virtual Private Cloud in the AWS CodeBuild User Guide .
Supporting Types
ProjectArtifacts
- Type string
- The type of build output artifact. Valid values include:
CODEPIPELINE: The build project has build output generated through CodePipeline. TheCODEPIPELINEtype is not supported forsecondaryArtifacts.NO_ARTIFACTS: The build project does not produce any build output.S3: The build project stores build output in Amazon S3.
- Artifact
Identifier string - An identifier for this artifact definition.
- Encryption
Disabled bool - Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an
invalidInputExceptionis thrown. - Location string
- Information about the build output artifact location:
- If
typeis set toCODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild. - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the name of the output bucket. If you specifyCODEPIPELINEorNO_ARTIFACTSfor theTypeproperty, don't specify this property. For all of the other types, you must specify this property.
- If
- Name string
Along with
pathandnamespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:- If
typeis set toCODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild . - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.
For example:
- If
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set toMyArtifact.zip, then the output artifact is stored inMyArtifacts/ *build-ID* /MyArtifact.zip. - If
pathis empty,namespaceTypeis set toNONE, andnameis set to "/", the output artifact is stored in the root of the output bucket. - If
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set to "/", the output artifact is stored inMyArtifacts/ *build-ID*.
If you specify
CODEPIPELINEorNO_ARTIFACTSfor theTypeproperty, don't specify this property. For all of the other types, you must specify this property.- If
- Namespace
Type string Along with
pathandname, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild .If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced.If
typeis set toS3, valid values include:BUILD_ID: Include the build ID in the location of the build output artifact.NONE: Do not include the build ID. This is the default ifnamespaceTypeis not specified.
For example, if
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set toMyArtifact.zip, the output artifact is stored inMyArtifacts/<build-ID>/MyArtifact.zip.- Override
Artifact boolName - If set to true a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell command language. For example, you can append a date and time to your artifact name so that it is always unique.
- Packaging string
The type of build output artifact to create:
If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of AWS CodeBuild .If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced.If
typeis set toS3, valid values include:NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default ifpackagingis not specified.ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.
- Path string
Along with
namespaceTypeandname, the pattern that AWS CodeBuild uses to name and store the output artifact:- If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild . - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the path to the output artifact. Ifpathis not specified,pathis not used.
For example, if
pathis set toMyArtifacts,namespaceTypeis set toNONE, andnameis set toMyArtifact.zip, the output artifact is stored in the output bucket atMyArtifacts/MyArtifact.zip.- If
- Type string
- The type of build output artifact. Valid values include:
CODEPIPELINE: The build project has build output generated through CodePipeline. TheCODEPIPELINEtype is not supported forsecondaryArtifacts.NO_ARTIFACTS: The build project does not produce any build output.S3: The build project stores build output in Amazon S3.
- Artifact
Identifier string - An identifier for this artifact definition.
- Encryption
Disabled bool - Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an
invalidInputExceptionis thrown. - Location string
- Information about the build output artifact location:
- If
typeis set toCODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild. - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the name of the output bucket. If you specifyCODEPIPELINEorNO_ARTIFACTSfor theTypeproperty, don't specify this property. For all of the other types, you must specify this property.
- If
- Name string
Along with
pathandnamespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:- If
typeis set toCODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild . - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.
For example:
- If
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set toMyArtifact.zip, then the output artifact is stored inMyArtifacts/ *build-ID* /MyArtifact.zip. - If
pathis empty,namespaceTypeis set toNONE, andnameis set to "/", the output artifact is stored in the root of the output bucket. - If
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set to "/", the output artifact is stored inMyArtifacts/ *build-ID*.
If you specify
CODEPIPELINEorNO_ARTIFACTSfor theTypeproperty, don't specify this property. For all of the other types, you must specify this property.- If
- Namespace
Type string Along with
pathandname, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild .If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced.If
typeis set toS3, valid values include:BUILD_ID: Include the build ID in the location of the build output artifact.NONE: Do not include the build ID. This is the default ifnamespaceTypeis not specified.
For example, if
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set toMyArtifact.zip, the output artifact is stored inMyArtifacts/<build-ID>/MyArtifact.zip.- Override
Artifact boolName - If set to true a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell command language. For example, you can append a date and time to your artifact name so that it is always unique.
- Packaging string
The type of build output artifact to create:
If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of AWS CodeBuild .If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced.If
typeis set toS3, valid values include:NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default ifpackagingis not specified.ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.
- Path string
Along with
namespaceTypeandname, the pattern that AWS CodeBuild uses to name and store the output artifact:- If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild . - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the path to the output artifact. Ifpathis not specified,pathis not used.
For example, if
pathis set toMyArtifacts,namespaceTypeis set toNONE, andnameis set toMyArtifact.zip, the output artifact is stored in the output bucket atMyArtifacts/MyArtifact.zip.- If
- type string
- The type of build output artifact. Valid values include:
CODEPIPELINE: The build project has build output generated through CodePipeline. TheCODEPIPELINEtype is not supported forsecondaryArtifacts.NO_ARTIFACTS: The build project does not produce any build output.S3: The build project stores build output in Amazon S3.
- artifact_
identifier string - An identifier for this artifact definition.
- encryption_
disabled bool - Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an
invalidInputExceptionis thrown. - location string
- Information about the build output artifact location:
- If
typeis set toCODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild. - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the name of the output bucket. If you specifyCODEPIPELINEorNO_ARTIFACTSfor theTypeproperty, don't specify this property. For all of the other types, you must specify this property.
- If
- name string
Along with
pathandnamespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:- If
typeis set toCODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild . - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.
For example:
- If
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set toMyArtifact.zip, then the output artifact is stored inMyArtifacts/ *build-ID* /MyArtifact.zip. - If
pathis empty,namespaceTypeis set toNONE, andnameis set to "/", the output artifact is stored in the root of the output bucket. - If
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set to "/", the output artifact is stored inMyArtifacts/ *build-ID*.
If you specify
CODEPIPELINEorNO_ARTIFACTSfor theTypeproperty, don't specify this property. For all of the other types, you must specify this property.- If
- namespace_
type string Along with
pathandname, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild .If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced.If
typeis set toS3, valid values include:BUILD_ID: Include the build ID in the location of the build output artifact.NONE: Do not include the build ID. This is the default ifnamespaceTypeis not specified.
For example, if
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set toMyArtifact.zip, the output artifact is stored inMyArtifacts/<build-ID>/MyArtifact.zip.- override_
artifact_ boolname - If set to true a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell command language. For example, you can append a date and time to your artifact name so that it is always unique.
- packaging string
The type of build output artifact to create:
If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of AWS CodeBuild .If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced.If
typeis set toS3, valid values include:NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default ifpackagingis not specified.ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.
- path string
Along with
namespaceTypeandname, the pattern that AWS CodeBuild uses to name and store the output artifact:- If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild . - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the path to the output artifact. Ifpathis not specified,pathis not used.
For example, if
pathis set toMyArtifacts,namespaceTypeis set toNONE, andnameis set toMyArtifact.zip, the output artifact is stored in the output bucket atMyArtifacts/MyArtifact.zip.- If
- type String
- The type of build output artifact. Valid values include:
CODEPIPELINE: The build project has build output generated through CodePipeline. TheCODEPIPELINEtype is not supported forsecondaryArtifacts.NO_ARTIFACTS: The build project does not produce any build output.S3: The build project stores build output in Amazon S3.
- artifact
Identifier String - An identifier for this artifact definition.
- encryption
Disabled Boolean - Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an
invalidInputExceptionis thrown. - location String
- Information about the build output artifact location:
- If
typeis set toCODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild. - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the name of the output bucket. If you specifyCODEPIPELINEorNO_ARTIFACTSfor theTypeproperty, don't specify this property. For all of the other types, you must specify this property.
- If
- name String
Along with
pathandnamespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:- If
typeis set toCODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild . - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.
For example:
- If
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set toMyArtifact.zip, then the output artifact is stored inMyArtifacts/ *build-ID* /MyArtifact.zip. - If
pathis empty,namespaceTypeis set toNONE, andnameis set to "/", the output artifact is stored in the root of the output bucket. - If
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set to "/", the output artifact is stored inMyArtifacts/ *build-ID*.
If you specify
CODEPIPELINEorNO_ARTIFACTSfor theTypeproperty, don't specify this property. For all of the other types, you must specify this property.- If
- namespace
Type String Along with
pathandname, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild .If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced.If
typeis set toS3, valid values include:BUILD_ID: Include the build ID in the location of the build output artifact.NONE: Do not include the build ID. This is the default ifnamespaceTypeis not specified.
For example, if
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set toMyArtifact.zip, the output artifact is stored inMyArtifacts/<build-ID>/MyArtifact.zip.- override
Artifact BooleanName - If set to true a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell command language. For example, you can append a date and time to your artifact name so that it is always unique.
- packaging String
The type of build output artifact to create:
If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of AWS CodeBuild .If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced.If
typeis set toS3, valid values include:NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default ifpackagingis not specified.ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.
- path String
Along with
namespaceTypeandname, the pattern that AWS CodeBuild uses to name and store the output artifact:- If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild . - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the path to the output artifact. Ifpathis not specified,pathis not used.
For example, if
pathis set toMyArtifacts,namespaceTypeis set toNONE, andnameis set toMyArtifact.zip, the output artifact is stored in the output bucket atMyArtifacts/MyArtifact.zip.- If
- type string
- The type of build output artifact. Valid values include:
CODEPIPELINE: The build project has build output generated through CodePipeline. TheCODEPIPELINEtype is not supported forsecondaryArtifacts.NO_ARTIFACTS: The build project does not produce any build output.S3: The build project stores build output in Amazon S3.
- artifact
Identifier string - An identifier for this artifact definition.
- encryption
Disabled boolean - Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an
invalidInputExceptionis thrown. - location string
- Information about the build output artifact location:
- If
typeis set toCODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild. - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the name of the output bucket. If you specifyCODEPIPELINEorNO_ARTIFACTSfor theTypeproperty, don't specify this property. For all of the other types, you must specify this property.
- If
- name string
Along with
pathandnamespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:- If
typeis set toCODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild . - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.
For example:
- If
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set toMyArtifact.zip, then the output artifact is stored inMyArtifacts/ *build-ID* /MyArtifact.zip. - If
pathis empty,namespaceTypeis set toNONE, andnameis set to "/", the output artifact is stored in the root of the output bucket. - If
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set to "/", the output artifact is stored inMyArtifacts/ *build-ID*.
If you specify
CODEPIPELINEorNO_ARTIFACTSfor theTypeproperty, don't specify this property. For all of the other types, you must specify this property.- If
- namespace
Type string Along with
pathandname, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild .If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced.If
typeis set toS3, valid values include:BUILD_ID: Include the build ID in the location of the build output artifact.NONE: Do not include the build ID. This is the default ifnamespaceTypeis not specified.
For example, if
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set toMyArtifact.zip, the output artifact is stored inMyArtifacts/<build-ID>/MyArtifact.zip.- override
Artifact booleanName - If set to true a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell command language. For example, you can append a date and time to your artifact name so that it is always unique.
- packaging string
The type of build output artifact to create:
If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of AWS CodeBuild .If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced.If
typeis set toS3, valid values include:NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default ifpackagingis not specified.ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.
- path string
Along with
namespaceTypeandname, the pattern that AWS CodeBuild uses to name and store the output artifact:- If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild . - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the path to the output artifact. Ifpathis not specified,pathis not used.
For example, if
pathis set toMyArtifacts,namespaceTypeis set toNONE, andnameis set toMyArtifact.zip, the output artifact is stored in the output bucket atMyArtifacts/MyArtifact.zip.- If
- type str
- The type of build output artifact. Valid values include:
CODEPIPELINE: The build project has build output generated through CodePipeline. TheCODEPIPELINEtype is not supported forsecondaryArtifacts.NO_ARTIFACTS: The build project does not produce any build output.S3: The build project stores build output in Amazon S3.
- artifact_
identifier str - An identifier for this artifact definition.
- encryption_
disabled bool - Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an
invalidInputExceptionis thrown. - location str
- Information about the build output artifact location:
- If
typeis set toCODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild. - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the name of the output bucket. If you specifyCODEPIPELINEorNO_ARTIFACTSfor theTypeproperty, don't specify this property. For all of the other types, you must specify this property.
- If
- name str
Along with
pathandnamespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:- If
typeis set toCODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild . - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.
For example:
- If
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set toMyArtifact.zip, then the output artifact is stored inMyArtifacts/ *build-ID* /MyArtifact.zip. - If
pathis empty,namespaceTypeis set toNONE, andnameis set to "/", the output artifact is stored in the root of the output bucket. - If
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set to "/", the output artifact is stored inMyArtifacts/ *build-ID*.
If you specify
CODEPIPELINEorNO_ARTIFACTSfor theTypeproperty, don't specify this property. For all of the other types, you must specify this property.- If
- namespace_
type str Along with
pathandname, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild .If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced.If
typeis set toS3, valid values include:BUILD_ID: Include the build ID in the location of the build output artifact.NONE: Do not include the build ID. This is the default ifnamespaceTypeis not specified.
For example, if
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set toMyArtifact.zip, the output artifact is stored inMyArtifacts/<build-ID>/MyArtifact.zip.- override_
artifact_ boolname - If set to true a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell command language. For example, you can append a date and time to your artifact name so that it is always unique.
- packaging str
The type of build output artifact to create:
If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of AWS CodeBuild .If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced.If
typeis set toS3, valid values include:NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default ifpackagingis not specified.ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.
- path str
Along with
namespaceTypeandname, the pattern that AWS CodeBuild uses to name and store the output artifact:- If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild . - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the path to the output artifact. Ifpathis not specified,pathis not used.
For example, if
pathis set toMyArtifacts,namespaceTypeis set toNONE, andnameis set toMyArtifact.zip, the output artifact is stored in the output bucket atMyArtifacts/MyArtifact.zip.- If
- type String
- The type of build output artifact. Valid values include:
CODEPIPELINE: The build project has build output generated through CodePipeline. TheCODEPIPELINEtype is not supported forsecondaryArtifacts.NO_ARTIFACTS: The build project does not produce any build output.S3: The build project stores build output in Amazon S3.
- artifact
Identifier String - An identifier for this artifact definition.
- encryption
Disabled Boolean - Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an
invalidInputExceptionis thrown. - location String
- Information about the build output artifact location:
- If
typeis set toCODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild. - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the name of the output bucket. If you specifyCODEPIPELINEorNO_ARTIFACTSfor theTypeproperty, don't specify this property. For all of the other types, you must specify this property.
- If
- name String
Along with
pathandnamespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:- If
typeis set toCODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild . - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.
For example:
- If
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set toMyArtifact.zip, then the output artifact is stored inMyArtifacts/ *build-ID* /MyArtifact.zip. - If
pathis empty,namespaceTypeis set toNONE, andnameis set to "/", the output artifact is stored in the root of the output bucket. - If
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set to "/", the output artifact is stored inMyArtifacts/ *build-ID*.
If you specify
CODEPIPELINEorNO_ARTIFACTSfor theTypeproperty, don't specify this property. For all of the other types, you must specify this property.- If
- namespace
Type String Along with
pathandname, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild .If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced.If
typeis set toS3, valid values include:BUILD_ID: Include the build ID in the location of the build output artifact.NONE: Do not include the build ID. This is the default ifnamespaceTypeis not specified.
For example, if
pathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set toMyArtifact.zip, the output artifact is stored inMyArtifacts/<build-ID>/MyArtifact.zip.- override
Artifact BooleanName - If set to true a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell command language. For example, you can append a date and time to your artifact name so that it is always unique.
- packaging String
The type of build output artifact to create:
If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of AWS CodeBuild .If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced.If
typeis set toS3, valid values include:NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default ifpackagingis not specified.ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.
- path String
Along with
namespaceTypeandname, the pattern that AWS CodeBuild uses to name and store the output artifact:- If
typeis set toCODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild . - If
typeis set toNO_ARTIFACTS, this value is ignored if specified, because no build output is produced. - If
typeis set toS3, this is the path to the output artifact. Ifpathis not specified,pathis not used.
For example, if
pathis set toMyArtifacts,namespaceTypeis set toNONE, andnameis set toMyArtifact.zip, the output artifact is stored in the output bucket atMyArtifacts/MyArtifact.zip.- If
ProjectBatchRestrictions
- Compute
Types List<string>Allowed - An array of strings that specify the compute types that are allowed for the batch build. See Build environment compute types in the AWS CodeBuild User Guide for these values.
- Fleets
Allowed List<string> - Maximum
Builds intAllowed - Specifies the maximum number of builds allowed.
- Compute
Types []stringAllowed - An array of strings that specify the compute types that are allowed for the batch build. See Build environment compute types in the AWS CodeBuild User Guide for these values.
- Fleets
Allowed []string - Maximum
Builds intAllowed - Specifies the maximum number of builds allowed.
- compute_
types_ list(string)allowed - An array of strings that specify the compute types that are allowed for the batch build. See Build environment compute types in the AWS CodeBuild User Guide for these values.
- fleets_
allowed list(string) - maximum_
builds_ numberallowed - Specifies the maximum number of builds allowed.
- compute
Types List<String>Allowed - An array of strings that specify the compute types that are allowed for the batch build. See Build environment compute types in the AWS CodeBuild User Guide for these values.
- fleets
Allowed List<String> - maximum
Builds IntegerAllowed - Specifies the maximum number of builds allowed.
- compute
Types string[]Allowed - An array of strings that specify the compute types that are allowed for the batch build. See Build environment compute types in the AWS CodeBuild User Guide for these values.
- fleets
Allowed string[] - maximum
Builds numberAllowed - Specifies the maximum number of builds allowed.
- compute_
types_ Sequence[str]allowed - An array of strings that specify the compute types that are allowed for the batch build. See Build environment compute types in the AWS CodeBuild User Guide for these values.
- fleets_
allowed Sequence[str] - maximum_
builds_ intallowed - Specifies the maximum number of builds allowed.
- compute
Types List<String>Allowed - An array of strings that specify the compute types that are allowed for the batch build. See Build environment compute types in the AWS CodeBuild User Guide for these values.
- fleets
Allowed List<String> - maximum
Builds NumberAllowed - Specifies the maximum number of builds allowed.
ProjectBuildBatchConfig
- Batch
Report stringMode - Specifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.
- REPORT_AGGREGATED_BATCH - (Default) Aggregate all of the build statuses into a single status report.
- REPORT_INDIVIDUAL_BUILDS - Send a separate status report for each individual build.
- Combine
Artifacts bool - Specifies if the build artifacts for the batch build should be combined into a single artifact location.
- Restrictions
Pulumi.
Aws Native. Code Build. Inputs. Project Batch Restrictions - A
BatchRestrictionsobject that specifies the restrictions for the batch build. - Service
Role string - Specifies the service role ARN for the batch build project.
- Timeout
In intMins - Specifies the maximum amount of time, in minutes, that the batch build must be completed in.
- Batch
Report stringMode - Specifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.
- REPORT_AGGREGATED_BATCH - (Default) Aggregate all of the build statuses into a single status report.
- REPORT_INDIVIDUAL_BUILDS - Send a separate status report for each individual build.
- Combine
Artifacts bool - Specifies if the build artifacts for the batch build should be combined into a single artifact location.
- Restrictions
Project
Batch Restrictions - A
BatchRestrictionsobject that specifies the restrictions for the batch build. - Service
Role string - Specifies the service role ARN for the batch build project.
- Timeout
In intMins - Specifies the maximum amount of time, in minutes, that the batch build must be completed in.
- batch_
report_ stringmode - Specifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.
- REPORT_AGGREGATED_BATCH - (Default) Aggregate all of the build statuses into a single status report.
- REPORT_INDIVIDUAL_BUILDS - Send a separate status report for each individual build.
- combine_
artifacts bool - Specifies if the build artifacts for the batch build should be combined into a single artifact location.
- restrictions object
- A
BatchRestrictionsobject that specifies the restrictions for the batch build. - service_
role string - Specifies the service role ARN for the batch build project.
- timeout_
in_ numbermins - Specifies the maximum amount of time, in minutes, that the batch build must be completed in.
- batch
Report StringMode - Specifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.
- REPORT_AGGREGATED_BATCH - (Default) Aggregate all of the build statuses into a single status report.
- REPORT_INDIVIDUAL_BUILDS - Send a separate status report for each individual build.
- combine
Artifacts Boolean - Specifies if the build artifacts for the batch build should be combined into a single artifact location.
- restrictions
Project
Batch Restrictions - A
BatchRestrictionsobject that specifies the restrictions for the batch build. - service
Role String - Specifies the service role ARN for the batch build project.
- timeout
In IntegerMins - Specifies the maximum amount of time, in minutes, that the batch build must be completed in.
- batch
Report stringMode - Specifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.
- REPORT_AGGREGATED_BATCH - (Default) Aggregate all of the build statuses into a single status report.
- REPORT_INDIVIDUAL_BUILDS - Send a separate status report for each individual build.
- combine
Artifacts boolean - Specifies if the build artifacts for the batch build should be combined into a single artifact location.
- restrictions
Project
Batch Restrictions - A
BatchRestrictionsobject that specifies the restrictions for the batch build. - service
Role string - Specifies the service role ARN for the batch build project.
- timeout
In numberMins - Specifies the maximum amount of time, in minutes, that the batch build must be completed in.
- batch_
report_ strmode - Specifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.
- REPORT_AGGREGATED_BATCH - (Default) Aggregate all of the build statuses into a single status report.
- REPORT_INDIVIDUAL_BUILDS - Send a separate status report for each individual build.
- combine_
artifacts bool - Specifies if the build artifacts for the batch build should be combined into a single artifact location.
- restrictions
Project
Batch Restrictions - A
BatchRestrictionsobject that specifies the restrictions for the batch build. - service_
role str - Specifies the service role ARN for the batch build project.
- timeout_
in_ intmins - Specifies the maximum amount of time, in minutes, that the batch build must be completed in.
- batch
Report StringMode - Specifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.
- REPORT_AGGREGATED_BATCH - (Default) Aggregate all of the build statuses into a single status report.
- REPORT_INDIVIDUAL_BUILDS - Send a separate status report for each individual build.
- combine
Artifacts Boolean - Specifies if the build artifacts for the batch build should be combined into a single artifact location.
- restrictions Property Map
- A
BatchRestrictionsobject that specifies the restrictions for the batch build. - service
Role String - Specifies the service role ARN for the batch build project.
- timeout
In NumberMins - Specifies the maximum amount of time, in minutes, that the batch build must be completed in.
ProjectBuildStatusConfig
- Context string
- Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
- Bitbucket - This parameter is used for the
nameparameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation. - GitHub/GitHub Enterprise Server - This parameter is used for the
contextparameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
- Bitbucket - This parameter is used for the
- Target
Url string - Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
- Bitbucket - This parameter is used for the
urlparameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation. - GitHub/GitHub Enterprise Server - This parameter is used for the
target_urlparameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
- Bitbucket - This parameter is used for the
- Context string
- Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
- Bitbucket - This parameter is used for the
nameparameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation. - GitHub/GitHub Enterprise Server - This parameter is used for the
contextparameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
- Bitbucket - This parameter is used for the
- Target
Url string - Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
- Bitbucket - This parameter is used for the
urlparameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation. - GitHub/GitHub Enterprise Server - This parameter is used for the
target_urlparameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
- Bitbucket - This parameter is used for the
- context string
- Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
- Bitbucket - This parameter is used for the
nameparameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation. - GitHub/GitHub Enterprise Server - This parameter is used for the
contextparameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
- Bitbucket - This parameter is used for the
- target_
url string - Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
- Bitbucket - This parameter is used for the
urlparameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation. - GitHub/GitHub Enterprise Server - This parameter is used for the
target_urlparameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
- Bitbucket - This parameter is used for the
- context String
- Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
- Bitbucket - This parameter is used for the
nameparameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation. - GitHub/GitHub Enterprise Server - This parameter is used for the
contextparameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
- Bitbucket - This parameter is used for the
- target
Url String - Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
- Bitbucket - This parameter is used for the
urlparameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation. - GitHub/GitHub Enterprise Server - This parameter is used for the
target_urlparameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
- Bitbucket - This parameter is used for the
- context string
- Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
- Bitbucket - This parameter is used for the
nameparameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation. - GitHub/GitHub Enterprise Server - This parameter is used for the
contextparameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
- Bitbucket - This parameter is used for the
- target
Url string - Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
- Bitbucket - This parameter is used for the
urlparameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation. - GitHub/GitHub Enterprise Server - This parameter is used for the
target_urlparameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
- Bitbucket - This parameter is used for the
- context str
- Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
- Bitbucket - This parameter is used for the
nameparameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation. - GitHub/GitHub Enterprise Server - This parameter is used for the
contextparameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
- Bitbucket - This parameter is used for the
- target_
url str - Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
- Bitbucket - This parameter is used for the
urlparameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation. - GitHub/GitHub Enterprise Server - This parameter is used for the
target_urlparameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
- Bitbucket - This parameter is used for the
- context String
- Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
- Bitbucket - This parameter is used for the
nameparameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation. - GitHub/GitHub Enterprise Server - This parameter is used for the
contextparameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
- Bitbucket - This parameter is used for the
- target
Url String - Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
- Bitbucket - This parameter is used for the
urlparameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation. - GitHub/GitHub Enterprise Server - This parameter is used for the
target_urlparameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
- Bitbucket - This parameter is used for the
ProjectCache
- Type string
- The type of cache used by the build project. Allowed values: NO_CACHE | S3 | LOCAL.
- Cache
Namespace string - Defines the scope of the cache. You can use this namespace to share a cache across multiple projects.
- Location string
- Information about the cache location:
NO_CACHEorLOCAL: This value is ignored.S3: This is the S3 bucket name/prefix.
- Modes List<string>
An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for
LOCALcache types.Possible values are:
- LOCAL_SOURCE_CACHE - Caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.
- LOCAL_DOCKER_LAYER_CACHE - Caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.
- You can use a Docker layer cache in the Linux environment only.
- The
privilegedflag must be set so that your project has the required Docker permissions. - You should consider the security implications before you use a Docker layer cache.
LOCAL_CUSTOM_CACHE - Caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:
Only directories can be specified for caching. You cannot specify individual files.
Symlinks are used to reference cached directories.
Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.
- Type string
- The type of cache used by the build project. Allowed values: NO_CACHE | S3 | LOCAL.
- Cache
Namespace string - Defines the scope of the cache. You can use this namespace to share a cache across multiple projects.
- Location string
- Information about the cache location:
NO_CACHEorLOCAL: This value is ignored.S3: This is the S3 bucket name/prefix.
- Modes []string
An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for
LOCALcache types.Possible values are:
- LOCAL_SOURCE_CACHE - Caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.
- LOCAL_DOCKER_LAYER_CACHE - Caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.
- You can use a Docker layer cache in the Linux environment only.
- The
privilegedflag must be set so that your project has the required Docker permissions. - You should consider the security implications before you use a Docker layer cache.
LOCAL_CUSTOM_CACHE - Caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:
Only directories can be specified for caching. You cannot specify individual files.
Symlinks are used to reference cached directories.
Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.
- type string
- The type of cache used by the build project. Allowed values: NO_CACHE | S3 | LOCAL.
- cache_
namespace string - Defines the scope of the cache. You can use this namespace to share a cache across multiple projects.
- location string
- Information about the cache location:
NO_CACHEorLOCAL: This value is ignored.S3: This is the S3 bucket name/prefix.
- modes list(string)
An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for
LOCALcache types.Possible values are:
- LOCAL_SOURCE_CACHE - Caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.
- LOCAL_DOCKER_LAYER_CACHE - Caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.
- You can use a Docker layer cache in the Linux environment only.
- The
privilegedflag must be set so that your project has the required Docker permissions. - You should consider the security implications before you use a Docker layer cache.
LOCAL_CUSTOM_CACHE - Caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:
Only directories can be specified for caching. You cannot specify individual files.
Symlinks are used to reference cached directories.
Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.
- type String
- The type of cache used by the build project. Allowed values: NO_CACHE | S3 | LOCAL.
- cache
Namespace String - Defines the scope of the cache. You can use this namespace to share a cache across multiple projects.
- location String
- Information about the cache location:
NO_CACHEorLOCAL: This value is ignored.S3: This is the S3 bucket name/prefix.
- modes List<String>
An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for
LOCALcache types.Possible values are:
- LOCAL_SOURCE_CACHE - Caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.
- LOCAL_DOCKER_LAYER_CACHE - Caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.
- You can use a Docker layer cache in the Linux environment only.
- The
privilegedflag must be set so that your project has the required Docker permissions. - You should consider the security implications before you use a Docker layer cache.
LOCAL_CUSTOM_CACHE - Caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:
Only directories can be specified for caching. You cannot specify individual files.
Symlinks are used to reference cached directories.
Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.
- type string
- The type of cache used by the build project. Allowed values: NO_CACHE | S3 | LOCAL.
- cache
Namespace string - Defines the scope of the cache. You can use this namespace to share a cache across multiple projects.
- location string
- Information about the cache location:
NO_CACHEorLOCAL: This value is ignored.S3: This is the S3 bucket name/prefix.
- modes string[]
An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for
LOCALcache types.Possible values are:
- LOCAL_SOURCE_CACHE - Caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.
- LOCAL_DOCKER_LAYER_CACHE - Caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.
- You can use a Docker layer cache in the Linux environment only.
- The
privilegedflag must be set so that your project has the required Docker permissions. - You should consider the security implications before you use a Docker layer cache.
LOCAL_CUSTOM_CACHE - Caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:
Only directories can be specified for caching. You cannot specify individual files.
Symlinks are used to reference cached directories.
Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.
- type str
- The type of cache used by the build project. Allowed values: NO_CACHE | S3 | LOCAL.
- cache_
namespace str - Defines the scope of the cache. You can use this namespace to share a cache across multiple projects.
- location str
- Information about the cache location:
NO_CACHEorLOCAL: This value is ignored.S3: This is the S3 bucket name/prefix.
- modes Sequence[str]
An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for
LOCALcache types.Possible values are:
- LOCAL_SOURCE_CACHE - Caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.
- LOCAL_DOCKER_LAYER_CACHE - Caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.
- You can use a Docker layer cache in the Linux environment only.
- The
privilegedflag must be set so that your project has the required Docker permissions. - You should consider the security implications before you use a Docker layer cache.
LOCAL_CUSTOM_CACHE - Caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:
Only directories can be specified for caching. You cannot specify individual files.
Symlinks are used to reference cached directories.
Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.
- type String
- The type of cache used by the build project. Allowed values: NO_CACHE | S3 | LOCAL.
- cache
Namespace String - Defines the scope of the cache. You can use this namespace to share a cache across multiple projects.
- location String
- Information about the cache location:
NO_CACHEorLOCAL: This value is ignored.S3: This is the S3 bucket name/prefix.
- modes List<String>
An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for
LOCALcache types.Possible values are:
- LOCAL_SOURCE_CACHE - Caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.
- LOCAL_DOCKER_LAYER_CACHE - Caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.
- You can use a Docker layer cache in the Linux environment only.
- The
privilegedflag must be set so that your project has the required Docker permissions. - You should consider the security implications before you use a Docker layer cache.
LOCAL_CUSTOM_CACHE - Caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:
Only directories can be specified for caching. You cannot specify individual files.
Symlinks are used to reference cached directories.
Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.
ProjectCloudWatchLogsConfig
- Status string
- The current status of the logs in CloudWatch Logs for a build project. Valid values are:
ENABLED: CloudWatch Logs are enabled for this build project.DISABLED: CloudWatch Logs are not enabled for this build project.
- Group
Name string - The group name of the logs in CloudWatch Logs. For more information, see Working with Log Groups and Log Streams .
- Stream
Name string - The prefix of the stream name of the CloudWatch Logs. For more information, see Working with Log Groups and Log Streams .
- Status string
- The current status of the logs in CloudWatch Logs for a build project. Valid values are:
ENABLED: CloudWatch Logs are enabled for this build project.DISABLED: CloudWatch Logs are not enabled for this build project.
- Group
Name string - The group name of the logs in CloudWatch Logs. For more information, see Working with Log Groups and Log Streams .
- Stream
Name string - The prefix of the stream name of the CloudWatch Logs. For more information, see Working with Log Groups and Log Streams .
- status string
- The current status of the logs in CloudWatch Logs for a build project. Valid values are:
ENABLED: CloudWatch Logs are enabled for this build project.DISABLED: CloudWatch Logs are not enabled for this build project.
- group_
name string - The group name of the logs in CloudWatch Logs. For more information, see Working with Log Groups and Log Streams .
- stream_
name string - The prefix of the stream name of the CloudWatch Logs. For more information, see Working with Log Groups and Log Streams .
- status String
- The current status of the logs in CloudWatch Logs for a build project. Valid values are:
ENABLED: CloudWatch Logs are enabled for this build project.DISABLED: CloudWatch Logs are not enabled for this build project.
- group
Name String - The group name of the logs in CloudWatch Logs. For more information, see Working with Log Groups and Log Streams .
- stream
Name String - The prefix of the stream name of the CloudWatch Logs. For more information, see Working with Log Groups and Log Streams .
- status string
- The current status of the logs in CloudWatch Logs for a build project. Valid values are:
ENABLED: CloudWatch Logs are enabled for this build project.DISABLED: CloudWatch Logs are not enabled for this build project.
- group
Name string - The group name of the logs in CloudWatch Logs. For more information, see Working with Log Groups and Log Streams .
- stream
Name string - The prefix of the stream name of the CloudWatch Logs. For more information, see Working with Log Groups and Log Streams .
- status str
- The current status of the logs in CloudWatch Logs for a build project. Valid values are:
ENABLED: CloudWatch Logs are enabled for this build project.DISABLED: CloudWatch Logs are not enabled for this build project.
- group_
name str - The group name of the logs in CloudWatch Logs. For more information, see Working with Log Groups and Log Streams .
- stream_
name str - The prefix of the stream name of the CloudWatch Logs. For more information, see Working with Log Groups and Log Streams .
- status String
- The current status of the logs in CloudWatch Logs for a build project. Valid values are:
ENABLED: CloudWatch Logs are enabled for this build project.DISABLED: CloudWatch Logs are not enabled for this build project.
- group
Name String - The group name of the logs in CloudWatch Logs. For more information, see Working with Log Groups and Log Streams .
- stream
Name String - The prefix of the stream name of the CloudWatch Logs. For more information, see Working with Log Groups and Log Streams .
ProjectDockerServer
- Compute
Type string - Information about the compute resources the docker server uses. Valid Values: BUILD_GENERAL1_SMALL | BUILD_GENERAL1_MEDIUM | BUILD_GENERAL1_LARGE | BUILD_GENERAL1_XLARGE | BUILD_GENERAL1_2XLARGE | BUILD_LAMBDA_1GB | BUILD_LAMBDA_2GB | BUILD_LAMBDA_4GB | BUILD_LAMBDA_8GB | BUILD_LAMBDA_10GB | ATTRIBUTE_BASED_COMPUTE | CUSTOM_INSTANCE_TYPE
- Security
Group List<string>Ids - A list of one or more security groups IDs.
- Compute
Type string - Information about the compute resources the docker server uses. Valid Values: BUILD_GENERAL1_SMALL | BUILD_GENERAL1_MEDIUM | BUILD_GENERAL1_LARGE | BUILD_GENERAL1_XLARGE | BUILD_GENERAL1_2XLARGE | BUILD_LAMBDA_1GB | BUILD_LAMBDA_2GB | BUILD_LAMBDA_4GB | BUILD_LAMBDA_8GB | BUILD_LAMBDA_10GB | ATTRIBUTE_BASED_COMPUTE | CUSTOM_INSTANCE_TYPE
- Security
Group []stringIds - A list of one or more security groups IDs.
- compute_
type string - Information about the compute resources the docker server uses. Valid Values: BUILD_GENERAL1_SMALL | BUILD_GENERAL1_MEDIUM | BUILD_GENERAL1_LARGE | BUILD_GENERAL1_XLARGE | BUILD_GENERAL1_2XLARGE | BUILD_LAMBDA_1GB | BUILD_LAMBDA_2GB | BUILD_LAMBDA_4GB | BUILD_LAMBDA_8GB | BUILD_LAMBDA_10GB | ATTRIBUTE_BASED_COMPUTE | CUSTOM_INSTANCE_TYPE
- security_
group_ list(string)ids - A list of one or more security groups IDs.
- compute
Type String - Information about the compute resources the docker server uses. Valid Values: BUILD_GENERAL1_SMALL | BUILD_GENERAL1_MEDIUM | BUILD_GENERAL1_LARGE | BUILD_GENERAL1_XLARGE | BUILD_GENERAL1_2XLARGE | BUILD_LAMBDA_1GB | BUILD_LAMBDA_2GB | BUILD_LAMBDA_4GB | BUILD_LAMBDA_8GB | BUILD_LAMBDA_10GB | ATTRIBUTE_BASED_COMPUTE | CUSTOM_INSTANCE_TYPE
- security
Group List<String>Ids - A list of one or more security groups IDs.
- compute
Type string - Information about the compute resources the docker server uses. Valid Values: BUILD_GENERAL1_SMALL | BUILD_GENERAL1_MEDIUM | BUILD_GENERAL1_LARGE | BUILD_GENERAL1_XLARGE | BUILD_GENERAL1_2XLARGE | BUILD_LAMBDA_1GB | BUILD_LAMBDA_2GB | BUILD_LAMBDA_4GB | BUILD_LAMBDA_8GB | BUILD_LAMBDA_10GB | ATTRIBUTE_BASED_COMPUTE | CUSTOM_INSTANCE_TYPE
- security
Group string[]Ids - A list of one or more security groups IDs.
- compute_
type str - Information about the compute resources the docker server uses. Valid Values: BUILD_GENERAL1_SMALL | BUILD_GENERAL1_MEDIUM | BUILD_GENERAL1_LARGE | BUILD_GENERAL1_XLARGE | BUILD_GENERAL1_2XLARGE | BUILD_LAMBDA_1GB | BUILD_LAMBDA_2GB | BUILD_LAMBDA_4GB | BUILD_LAMBDA_8GB | BUILD_LAMBDA_10GB | ATTRIBUTE_BASED_COMPUTE | CUSTOM_INSTANCE_TYPE
- security_
group_ Sequence[str]ids - A list of one or more security groups IDs.
- compute
Type String - Information about the compute resources the docker server uses. Valid Values: BUILD_GENERAL1_SMALL | BUILD_GENERAL1_MEDIUM | BUILD_GENERAL1_LARGE | BUILD_GENERAL1_XLARGE | BUILD_GENERAL1_2XLARGE | BUILD_LAMBDA_1GB | BUILD_LAMBDA_2GB | BUILD_LAMBDA_4GB | BUILD_LAMBDA_8GB | BUILD_LAMBDA_10GB | ATTRIBUTE_BASED_COMPUTE | CUSTOM_INSTANCE_TYPE
- security
Group List<String>Ids - A list of one or more security groups IDs.
ProjectEnvironment
- Compute
Type string The type of compute environment. This determines the number of CPU cores and memory the build environment uses. Available values include:
ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use
ATTRIBUTE_BASED_COMPUTE, you must define your attributes by usingcomputeConfiguration. AWS CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the AWS CodeBuild User Guide .BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.
If you use
BUILD_GENERAL1_SMALL:- For environment type
LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds. - For environment type
LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds. - For environment type
ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.
If you use
BUILD_GENERAL1_LARGE:- For environment type
LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds. - For environment type
LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds. - For environment type
ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types in the AWS CodeBuild User Guide.
- Image string
The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:
- For an image tag:
<registry>/<repository>:<tag>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would beaws/codebuild/standard:4.0. - For an image digest:
<registry>/<repository>@<digest>. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use<registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.
For more information, see Docker images provided by CodeBuild in the AWS CodeBuild user guide .
- For an image tag:
- Type string
The type of build environment to use for related builds.
If you're using compute fleets during project creation,
typewill be ignored.For more information, see Build environment compute types in the AWS CodeBuild user guide .
- Certificate string
- The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see certificate in the AWS CodeBuild User Guide .
- Docker
Server Pulumi.Aws Native. Code Build. Inputs. Project Docker Server - Contains docker server information.
- Environment
Variables List<Pulumi.Aws Native. Code Build. Inputs. Project Environment Variable> - A set of environment variables to make available to builds for this build project.
- Fleet
Pulumi.
Aws Native. Code Build. Inputs. Project Fleet - Host
Kernel string - The kernel version of the host operating system for the build environment. Allowed values: LINUX_KERNEL_4 | LINUX_KERNEL_6 | LINUX_KERNEL_LATEST
- Image
Pull stringCredentials Type The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:
CODEBUILDspecifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild service principal.SERVICE_ROLEspecifies that AWS CodeBuild uses your build project's service role.
When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.
- Privileged
Mode bool Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is
false.You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:
If the operating system's base image is Ubuntu Linux:
- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"If the operating system's base image is Alpine Linux and the previous command does not work, add the
-targument totimeout:- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"- Registry
Credential Pulumi.Aws Native. Code Build. Inputs. Project Registry Credential RegistryCredentialis a property of the AWS::CodeBuild::Project Environment property that specifies information about credentials that provide access to a private Docker registry. When this is set:imagePullCredentialsTypemust be set toSERVICE_ROLE.- images cannot be curated or an Amazon ECR image.
- Compute
Type string The type of compute environment. This determines the number of CPU cores and memory the build environment uses. Available values include:
ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use
ATTRIBUTE_BASED_COMPUTE, you must define your attributes by usingcomputeConfiguration. AWS CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the AWS CodeBuild User Guide .BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.
If you use
BUILD_GENERAL1_SMALL:- For environment type
LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds. - For environment type
LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds. - For environment type
ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.
If you use
BUILD_GENERAL1_LARGE:- For environment type
LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds. - For environment type
LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds. - For environment type
ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types in the AWS CodeBuild User Guide.
- Image string
The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:
- For an image tag:
<registry>/<repository>:<tag>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would beaws/codebuild/standard:4.0. - For an image digest:
<registry>/<repository>@<digest>. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use<registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.
For more information, see Docker images provided by CodeBuild in the AWS CodeBuild user guide .
- For an image tag:
- Type string
The type of build environment to use for related builds.
If you're using compute fleets during project creation,
typewill be ignored.For more information, see Build environment compute types in the AWS CodeBuild user guide .
- Certificate string
- The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see certificate in the AWS CodeBuild User Guide .
- Docker
Server ProjectDocker Server - Contains docker server information.
- Environment
Variables []ProjectEnvironment Variable - A set of environment variables to make available to builds for this build project.
- Fleet
Project
Fleet - Host
Kernel string - The kernel version of the host operating system for the build environment. Allowed values: LINUX_KERNEL_4 | LINUX_KERNEL_6 | LINUX_KERNEL_LATEST
- Image
Pull stringCredentials Type The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:
CODEBUILDspecifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild service principal.SERVICE_ROLEspecifies that AWS CodeBuild uses your build project's service role.
When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.
- Privileged
Mode bool Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is
false.You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:
If the operating system's base image is Ubuntu Linux:
- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"If the operating system's base image is Alpine Linux and the previous command does not work, add the
-targument totimeout:- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"- Registry
Credential ProjectRegistry Credential RegistryCredentialis a property of the AWS::CodeBuild::Project Environment property that specifies information about credentials that provide access to a private Docker registry. When this is set:imagePullCredentialsTypemust be set toSERVICE_ROLE.- images cannot be curated or an Amazon ECR image.
- compute_
type string The type of compute environment. This determines the number of CPU cores and memory the build environment uses. Available values include:
ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use
ATTRIBUTE_BASED_COMPUTE, you must define your attributes by usingcomputeConfiguration. AWS CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the AWS CodeBuild User Guide .BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.
If you use
BUILD_GENERAL1_SMALL:- For environment type
LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds. - For environment type
LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds. - For environment type
ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.
If you use
BUILD_GENERAL1_LARGE:- For environment type
LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds. - For environment type
LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds. - For environment type
ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types in the AWS CodeBuild User Guide.
- image string
The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:
- For an image tag:
<registry>/<repository>:<tag>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would beaws/codebuild/standard:4.0. - For an image digest:
<registry>/<repository>@<digest>. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use<registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.
For more information, see Docker images provided by CodeBuild in the AWS CodeBuild user guide .
- For an image tag:
- type string
The type of build environment to use for related builds.
If you're using compute fleets during project creation,
typewill be ignored.For more information, see Build environment compute types in the AWS CodeBuild user guide .
- certificate string
- The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see certificate in the AWS CodeBuild User Guide .
- docker_
server object - Contains docker server information.
- environment_
variables list(object) - A set of environment variables to make available to builds for this build project.
- fleet object
- host_
kernel string - The kernel version of the host operating system for the build environment. Allowed values: LINUX_KERNEL_4 | LINUX_KERNEL_6 | LINUX_KERNEL_LATEST
- image_
pull_ stringcredentials_ type The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:
CODEBUILDspecifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild service principal.SERVICE_ROLEspecifies that AWS CodeBuild uses your build project's service role.
When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.
- privileged_
mode bool Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is
false.You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:
If the operating system's base image is Ubuntu Linux:
- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"If the operating system's base image is Alpine Linux and the previous command does not work, add the
-targument totimeout:- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"- registry_
credential object RegistryCredentialis a property of the AWS::CodeBuild::Project Environment property that specifies information about credentials that provide access to a private Docker registry. When this is set:imagePullCredentialsTypemust be set toSERVICE_ROLE.- images cannot be curated or an Amazon ECR image.
- compute
Type String The type of compute environment. This determines the number of CPU cores and memory the build environment uses. Available values include:
ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use
ATTRIBUTE_BASED_COMPUTE, you must define your attributes by usingcomputeConfiguration. AWS CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the AWS CodeBuild User Guide .BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.
If you use
BUILD_GENERAL1_SMALL:- For environment type
LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds. - For environment type
LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds. - For environment type
ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.
If you use
BUILD_GENERAL1_LARGE:- For environment type
LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds. - For environment type
LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds. - For environment type
ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types in the AWS CodeBuild User Guide.
- image String
The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:
- For an image tag:
<registry>/<repository>:<tag>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would beaws/codebuild/standard:4.0. - For an image digest:
<registry>/<repository>@<digest>. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use<registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.
For more information, see Docker images provided by CodeBuild in the AWS CodeBuild user guide .
- For an image tag:
- type String
The type of build environment to use for related builds.
If you're using compute fleets during project creation,
typewill be ignored.For more information, see Build environment compute types in the AWS CodeBuild user guide .
- certificate String
- The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see certificate in the AWS CodeBuild User Guide .
- docker
Server ProjectDocker Server - Contains docker server information.
- environment
Variables List<ProjectEnvironment Variable> - A set of environment variables to make available to builds for this build project.
- fleet
Project
Fleet - host
Kernel String - The kernel version of the host operating system for the build environment. Allowed values: LINUX_KERNEL_4 | LINUX_KERNEL_6 | LINUX_KERNEL_LATEST
- image
Pull StringCredentials Type The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:
CODEBUILDspecifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild service principal.SERVICE_ROLEspecifies that AWS CodeBuild uses your build project's service role.
When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.
- privileged
Mode Boolean Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is
false.You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:
If the operating system's base image is Ubuntu Linux:
- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"If the operating system's base image is Alpine Linux and the previous command does not work, add the
-targument totimeout:- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"- registry
Credential ProjectRegistry Credential RegistryCredentialis a property of the AWS::CodeBuild::Project Environment property that specifies information about credentials that provide access to a private Docker registry. When this is set:imagePullCredentialsTypemust be set toSERVICE_ROLE.- images cannot be curated or an Amazon ECR image.
- compute
Type string The type of compute environment. This determines the number of CPU cores and memory the build environment uses. Available values include:
ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use
ATTRIBUTE_BASED_COMPUTE, you must define your attributes by usingcomputeConfiguration. AWS CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the AWS CodeBuild User Guide .BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.
If you use
BUILD_GENERAL1_SMALL:- For environment type
LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds. - For environment type
LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds. - For environment type
ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.
If you use
BUILD_GENERAL1_LARGE:- For environment type
LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds. - For environment type
LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds. - For environment type
ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types in the AWS CodeBuild User Guide.
- image string
The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:
- For an image tag:
<registry>/<repository>:<tag>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would beaws/codebuild/standard:4.0. - For an image digest:
<registry>/<repository>@<digest>. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use<registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.
For more information, see Docker images provided by CodeBuild in the AWS CodeBuild user guide .
- For an image tag:
- type string
The type of build environment to use for related builds.
If you're using compute fleets during project creation,
typewill be ignored.For more information, see Build environment compute types in the AWS CodeBuild user guide .
- certificate string
- The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see certificate in the AWS CodeBuild User Guide .
- docker
Server ProjectDocker Server - Contains docker server information.
- environment
Variables ProjectEnvironment Variable[] - A set of environment variables to make available to builds for this build project.
- fleet
Project
Fleet - host
Kernel string - The kernel version of the host operating system for the build environment. Allowed values: LINUX_KERNEL_4 | LINUX_KERNEL_6 | LINUX_KERNEL_LATEST
- image
Pull stringCredentials Type The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:
CODEBUILDspecifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild service principal.SERVICE_ROLEspecifies that AWS CodeBuild uses your build project's service role.
When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.
- privileged
Mode boolean Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is
false.You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:
If the operating system's base image is Ubuntu Linux:
- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"If the operating system's base image is Alpine Linux and the previous command does not work, add the
-targument totimeout:- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"- registry
Credential ProjectRegistry Credential RegistryCredentialis a property of the AWS::CodeBuild::Project Environment property that specifies information about credentials that provide access to a private Docker registry. When this is set:imagePullCredentialsTypemust be set toSERVICE_ROLE.- images cannot be curated or an Amazon ECR image.
- compute_
type str The type of compute environment. This determines the number of CPU cores and memory the build environment uses. Available values include:
ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use
ATTRIBUTE_BASED_COMPUTE, you must define your attributes by usingcomputeConfiguration. AWS CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the AWS CodeBuild User Guide .BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.
If you use
BUILD_GENERAL1_SMALL:- For environment type
LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds. - For environment type
LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds. - For environment type
ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.
If you use
BUILD_GENERAL1_LARGE:- For environment type
LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds. - For environment type
LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds. - For environment type
ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types in the AWS CodeBuild User Guide.
- image str
The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:
- For an image tag:
<registry>/<repository>:<tag>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would beaws/codebuild/standard:4.0. - For an image digest:
<registry>/<repository>@<digest>. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use<registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.
For more information, see Docker images provided by CodeBuild in the AWS CodeBuild user guide .
- For an image tag:
- type str
The type of build environment to use for related builds.
If you're using compute fleets during project creation,
typewill be ignored.For more information, see Build environment compute types in the AWS CodeBuild user guide .
- certificate str
- The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see certificate in the AWS CodeBuild User Guide .
- docker_
server ProjectDocker Server - Contains docker server information.
- environment_
variables Sequence[ProjectEnvironment Variable] - A set of environment variables to make available to builds for this build project.
- fleet
Project
Fleet - host_
kernel str - The kernel version of the host operating system for the build environment. Allowed values: LINUX_KERNEL_4 | LINUX_KERNEL_6 | LINUX_KERNEL_LATEST
- image_
pull_ strcredentials_ type The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:
CODEBUILDspecifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild service principal.SERVICE_ROLEspecifies that AWS CodeBuild uses your build project's service role.
When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.
- privileged_
mode bool Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is
false.You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:
If the operating system's base image is Ubuntu Linux:
- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"If the operating system's base image is Alpine Linux and the previous command does not work, add the
-targument totimeout:- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"- registry_
credential ProjectRegistry Credential RegistryCredentialis a property of the AWS::CodeBuild::Project Environment property that specifies information about credentials that provide access to a private Docker registry. When this is set:imagePullCredentialsTypemust be set toSERVICE_ROLE.- images cannot be curated or an Amazon ECR image.
- compute
Type String The type of compute environment. This determines the number of CPU cores and memory the build environment uses. Available values include:
ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use
ATTRIBUTE_BASED_COMPUTE, you must define your attributes by usingcomputeConfiguration. AWS CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the AWS CodeBuild User Guide .BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINERandARM_LAMBDA_CONTAINER.
If you use
BUILD_GENERAL1_SMALL:- For environment type
LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds. - For environment type
LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds. - For environment type
ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.
If you use
BUILD_GENERAL1_LARGE:- For environment type
LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds. - For environment type
LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds. - For environment type
ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see On-demand environment types in the AWS CodeBuild User Guide.
- image String
The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:
- For an image tag:
<registry>/<repository>:<tag>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would beaws/codebuild/standard:4.0. - For an image digest:
<registry>/<repository>@<digest>. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use<registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.
For more information, see Docker images provided by CodeBuild in the AWS CodeBuild user guide .
- For an image tag:
- type String
The type of build environment to use for related builds.
If you're using compute fleets during project creation,
typewill be ignored.For more information, see Build environment compute types in the AWS CodeBuild user guide .
- certificate String
- The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see certificate in the AWS CodeBuild User Guide .
- docker
Server Property Map - Contains docker server information.
- environment
Variables List<Property Map> - A set of environment variables to make available to builds for this build project.
- fleet Property Map
- host
Kernel String - The kernel version of the host operating system for the build environment. Allowed values: LINUX_KERNEL_4 | LINUX_KERNEL_6 | LINUX_KERNEL_LATEST
- image
Pull StringCredentials Type The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:
CODEBUILDspecifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild service principal.SERVICE_ROLEspecifies that AWS CodeBuild uses your build project's service role.
When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.
- privileged
Mode Boolean Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is
false.You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:
If the operating system's base image is Ubuntu Linux:
- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"If the operating system's base image is Alpine Linux and the previous command does not work, add the
-targument totimeout:- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"- registry
Credential Property Map RegistryCredentialis a property of the AWS::CodeBuild::Project Environment property that specifies information about credentials that provide access to a private Docker registry. When this is set:imagePullCredentialsTypemust be set toSERVICE_ROLE.- images cannot be curated or an Amazon ECR image.
ProjectEnvironmentVariable
- Name string
- The name or key of the environment variable.
- Value string
The value of the environment variable.
We strongly discourage the use of
PLAINTEXTenvironment variables to store sensitive values, especially AWS secret key IDs.PLAINTEXTenvironment variables can be displayed in plain text using the AWS CodeBuild console and the AWS CLI . For sensitive values, we recommend you use an environment variable of typePARAMETER_STOREorSECRETS_MANAGER.- Type string
- The type of environment variable. Valid values include:
PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as thevalueof the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the AWS CodeBuild User Guide .PLAINTEXT: An environment variable in plain text format. This is the default value.SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager . For environment variables of this type, specify the name of the secret as thevalueof the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define AWS Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the AWS CodeBuild User Guide .
- Name string
- The name or key of the environment variable.
- Value string
The value of the environment variable.
We strongly discourage the use of
PLAINTEXTenvironment variables to store sensitive values, especially AWS secret key IDs.PLAINTEXTenvironment variables can be displayed in plain text using the AWS CodeBuild console and the AWS CLI . For sensitive values, we recommend you use an environment variable of typePARAMETER_STOREorSECRETS_MANAGER.- Type string
- The type of environment variable. Valid values include:
PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as thevalueof the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the AWS CodeBuild User Guide .PLAINTEXT: An environment variable in plain text format. This is the default value.SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager . For environment variables of this type, specify the name of the secret as thevalueof the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define AWS Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the AWS CodeBuild User Guide .
- name string
- The name or key of the environment variable.
- value string
The value of the environment variable.
We strongly discourage the use of
PLAINTEXTenvironment variables to store sensitive values, especially AWS secret key IDs.PLAINTEXTenvironment variables can be displayed in plain text using the AWS CodeBuild console and the AWS CLI . For sensitive values, we recommend you use an environment variable of typePARAMETER_STOREorSECRETS_MANAGER.- type string
- The type of environment variable. Valid values include:
PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as thevalueof the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the AWS CodeBuild User Guide .PLAINTEXT: An environment variable in plain text format. This is the default value.SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager . For environment variables of this type, specify the name of the secret as thevalueof the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define AWS Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the AWS CodeBuild User Guide .
- name String
- The name or key of the environment variable.
- value String
The value of the environment variable.
We strongly discourage the use of
PLAINTEXTenvironment variables to store sensitive values, especially AWS secret key IDs.PLAINTEXTenvironment variables can be displayed in plain text using the AWS CodeBuild console and the AWS CLI . For sensitive values, we recommend you use an environment variable of typePARAMETER_STOREorSECRETS_MANAGER.- type String
- The type of environment variable. Valid values include:
PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as thevalueof the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the AWS CodeBuild User Guide .PLAINTEXT: An environment variable in plain text format. This is the default value.SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager . For environment variables of this type, specify the name of the secret as thevalueof the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define AWS Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the AWS CodeBuild User Guide .
- name string
- The name or key of the environment variable.
- value string
The value of the environment variable.
We strongly discourage the use of
PLAINTEXTenvironment variables to store sensitive values, especially AWS secret key IDs.PLAINTEXTenvironment variables can be displayed in plain text using the AWS CodeBuild console and the AWS CLI . For sensitive values, we recommend you use an environment variable of typePARAMETER_STOREorSECRETS_MANAGER.- type string
- The type of environment variable. Valid values include:
PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as thevalueof the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the AWS CodeBuild User Guide .PLAINTEXT: An environment variable in plain text format. This is the default value.SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager . For environment variables of this type, specify the name of the secret as thevalueof the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define AWS Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the AWS CodeBuild User Guide .
- name str
- The name or key of the environment variable.
- value str
The value of the environment variable.
We strongly discourage the use of
PLAINTEXTenvironment variables to store sensitive values, especially AWS secret key IDs.PLAINTEXTenvironment variables can be displayed in plain text using the AWS CodeBuild console and the AWS CLI . For sensitive values, we recommend you use an environment variable of typePARAMETER_STOREorSECRETS_MANAGER.- type str
- The type of environment variable. Valid values include:
PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as thevalueof the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the AWS CodeBuild User Guide .PLAINTEXT: An environment variable in plain text format. This is the default value.SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager . For environment variables of this type, specify the name of the secret as thevalueof the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define AWS Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the AWS CodeBuild User Guide .
- name String
- The name or key of the environment variable.
- value String
The value of the environment variable.
We strongly discourage the use of
PLAINTEXTenvironment variables to store sensitive values, especially AWS secret key IDs.PLAINTEXTenvironment variables can be displayed in plain text using the AWS CodeBuild console and the AWS CLI . For sensitive values, we recommend you use an environment variable of typePARAMETER_STOREorSECRETS_MANAGER.- type String
- The type of environment variable. Valid values include:
PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as thevalueof the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the AWS CodeBuild User Guide .PLAINTEXT: An environment variable in plain text format. This is the default value.SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager . For environment variables of this type, specify the name of the secret as thevalueof the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define AWS Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the AWS CodeBuild User Guide .
ProjectFileSystemLocation
- Identifier string
The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the
identifierin all capital letters toCODEBUILD_. For example, if you specifymy_efsforidentifier, a new environment variable is create namedCODEBUILD_MY_EFS.The
identifieris used to mount your file system.- Location string
A string that specifies the location of the file system created by Amazon EFS. Its format is
efs-dns-name:/directory-path. You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system isfs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory ismy-efs-mount-directory, then thelocationisfs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.The directory path in the format
efs-dns-name:/directory-pathis optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.- Mount
Point string - The location in the container where you mount the file system.
- Type string
- The type of the file system. The one supported type is
EFS. - Mount
Options string - The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are
nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For more information, see Recommended NFS Mount Options .
- Identifier string
The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the
identifierin all capital letters toCODEBUILD_. For example, if you specifymy_efsforidentifier, a new environment variable is create namedCODEBUILD_MY_EFS.The
identifieris used to mount your file system.- Location string
A string that specifies the location of the file system created by Amazon EFS. Its format is
efs-dns-name:/directory-path. You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system isfs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory ismy-efs-mount-directory, then thelocationisfs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.The directory path in the format
efs-dns-name:/directory-pathis optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.- Mount
Point string - The location in the container where you mount the file system.
- Type string
- The type of the file system. The one supported type is
EFS. - Mount
Options string - The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are
nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For more information, see Recommended NFS Mount Options .
- identifier string
The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the
identifierin all capital letters toCODEBUILD_. For example, if you specifymy_efsforidentifier, a new environment variable is create namedCODEBUILD_MY_EFS.The
identifieris used to mount your file system.- location string
A string that specifies the location of the file system created by Amazon EFS. Its format is
efs-dns-name:/directory-path. You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system isfs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory ismy-efs-mount-directory, then thelocationisfs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.The directory path in the format
efs-dns-name:/directory-pathis optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.- mount_
point string - The location in the container where you mount the file system.
- type string
- The type of the file system. The one supported type is
EFS. - mount_
options string - The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are
nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For more information, see Recommended NFS Mount Options .
- identifier String
The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the
identifierin all capital letters toCODEBUILD_. For example, if you specifymy_efsforidentifier, a new environment variable is create namedCODEBUILD_MY_EFS.The
identifieris used to mount your file system.- location String
A string that specifies the location of the file system created by Amazon EFS. Its format is
efs-dns-name:/directory-path. You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system isfs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory ismy-efs-mount-directory, then thelocationisfs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.The directory path in the format
efs-dns-name:/directory-pathis optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.- mount
Point String - The location in the container where you mount the file system.
- type String
- The type of the file system. The one supported type is
EFS. - mount
Options String - The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are
nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For more information, see Recommended NFS Mount Options .
- identifier string
The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the
identifierin all capital letters toCODEBUILD_. For example, if you specifymy_efsforidentifier, a new environment variable is create namedCODEBUILD_MY_EFS.The
identifieris used to mount your file system.- location string
A string that specifies the location of the file system created by Amazon EFS. Its format is
efs-dns-name:/directory-path. You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system isfs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory ismy-efs-mount-directory, then thelocationisfs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.The directory path in the format
efs-dns-name:/directory-pathis optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.- mount
Point string - The location in the container where you mount the file system.
- type string
- The type of the file system. The one supported type is
EFS. - mount
Options string - The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are
nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For more information, see Recommended NFS Mount Options .
- identifier str
The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the
identifierin all capital letters toCODEBUILD_. For example, if you specifymy_efsforidentifier, a new environment variable is create namedCODEBUILD_MY_EFS.The
identifieris used to mount your file system.- location str
A string that specifies the location of the file system created by Amazon EFS. Its format is
efs-dns-name:/directory-path. You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system isfs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory ismy-efs-mount-directory, then thelocationisfs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.The directory path in the format
efs-dns-name:/directory-pathis optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.- mount_
point str - The location in the container where you mount the file system.
- type str
- The type of the file system. The one supported type is
EFS. - mount_
options str - The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are
nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For more information, see Recommended NFS Mount Options .
- identifier String
The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the
identifierin all capital letters toCODEBUILD_. For example, if you specifymy_efsforidentifier, a new environment variable is create namedCODEBUILD_MY_EFS.The
identifieris used to mount your file system.- location String
A string that specifies the location of the file system created by Amazon EFS. Its format is
efs-dns-name:/directory-path. You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system isfs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory ismy-efs-mount-directory, then thelocationisfs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.The directory path in the format
efs-dns-name:/directory-pathis optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.- mount
Point String - The location in the container where you mount the file system.
- type String
- The type of the file system. The one supported type is
EFS. - mount
Options String - The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are
nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For more information, see Recommended NFS Mount Options .
ProjectFleet
- Fleet
Arn string - Specifies the compute fleet ARN for the build project.
- Fleet
Arn string - Specifies the compute fleet ARN for the build project.
- fleet_
arn string - Specifies the compute fleet ARN for the build project.
- fleet
Arn String - Specifies the compute fleet ARN for the build project.
- fleet
Arn string - Specifies the compute fleet ARN for the build project.
- fleet_
arn str - Specifies the compute fleet ARN for the build project.
- fleet
Arn String - Specifies the compute fleet ARN for the build project.
ProjectGitSubmodulesConfig
- Fetch
Submodules bool - Set to true to fetch Git submodules for your AWS CodeBuild build project.
- Fetch
Submodules bool - Set to true to fetch Git submodules for your AWS CodeBuild build project.
- fetch_
submodules bool - Set to true to fetch Git submodules for your AWS CodeBuild build project.
- fetch
Submodules Boolean - Set to true to fetch Git submodules for your AWS CodeBuild build project.
- fetch
Submodules boolean - Set to true to fetch Git submodules for your AWS CodeBuild build project.
- fetch_
submodules bool - Set to true to fetch Git submodules for your AWS CodeBuild build project.
- fetch
Submodules Boolean - Set to true to fetch Git submodules for your AWS CodeBuild build project.
ProjectLogsConfig
- Cloud
Watch Pulumi.Logs Aws Native. Code Build. Inputs. Project Cloud Watch Logs Config - Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default.
- S3Logs
Pulumi.
Aws Native. Code Build. Inputs. Project S3Logs Config - Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default.
- Cloud
Watch ProjectLogs Cloud Watch Logs Config - Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default.
- S3Logs
Project
S3Logs Config - Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default.
- cloud_
watch_ objectlogs - Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default.
- s3_
logs object - Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default.
- cloud
Watch ProjectLogs Cloud Watch Logs Config - Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default.
- s3Logs
Project
S3Logs Config - Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default.
- cloud
Watch ProjectLogs Cloud Watch Logs Config - Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default.
- s3Logs
Project
S3Logs Config - Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default.
- cloud_
watch_ Projectlogs Cloud Watch Logs Config - Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default.
- s3_
logs ProjectS3Logs Config - Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default.
- cloud
Watch Property MapLogs - Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default.
- s3Logs Property Map
- Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default.
ProjectRegistryCredential
- Credential string
The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager .
The
credentialcan use the name of the credentials only if they exist in your current AWS Region .- Credential
Provider string - The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager .
- Credential string
The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager .
The
credentialcan use the name of the credentials only if they exist in your current AWS Region .- Credential
Provider string - The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager .
- credential string
The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager .
The
credentialcan use the name of the credentials only if they exist in your current AWS Region .- credential_
provider string - The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager .
- credential String
The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager .
The
credentialcan use the name of the credentials only if they exist in your current AWS Region .- credential
Provider String - The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager .
- credential string
The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager .
The
credentialcan use the name of the credentials only if they exist in your current AWS Region .- credential
Provider string - The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager .
- credential str
The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager .
The
credentialcan use the name of the credentials only if they exist in your current AWS Region .- credential_
provider str - The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager .
- credential String
The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager .
The
credentialcan use the name of the credentials only if they exist in your current AWS Region .- credential
Provider String - The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager .
ProjectS3LogsConfig
- Status string
- The current status of the S3 build logs. Valid values are:
ENABLED: S3 build logs are enabled for this build project.DISABLED: S3 build logs are not enabled for this build project.
- Encryption
Disabled bool - Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.
- Location string
- The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is
my-bucket, and your path prefix isbuild-log, then acceptable formats aremy-bucket/build-logorarn:aws:s3:::my-bucket/build-log.
- Status string
- The current status of the S3 build logs. Valid values are:
ENABLED: S3 build logs are enabled for this build project.DISABLED: S3 build logs are not enabled for this build project.
- Encryption
Disabled bool - Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.
- Location string
- The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is
my-bucket, and your path prefix isbuild-log, then acceptable formats aremy-bucket/build-logorarn:aws:s3:::my-bucket/build-log.
- status string
- The current status of the S3 build logs. Valid values are:
ENABLED: S3 build logs are enabled for this build project.DISABLED: S3 build logs are not enabled for this build project.
- encryption_
disabled bool - Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.
- location string
- The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is
my-bucket, and your path prefix isbuild-log, then acceptable formats aremy-bucket/build-logorarn:aws:s3:::my-bucket/build-log.
- status String
- The current status of the S3 build logs. Valid values are:
ENABLED: S3 build logs are enabled for this build project.DISABLED: S3 build logs are not enabled for this build project.
- encryption
Disabled Boolean - Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.
- location String
- The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is
my-bucket, and your path prefix isbuild-log, then acceptable formats aremy-bucket/build-logorarn:aws:s3:::my-bucket/build-log.
- status string
- The current status of the S3 build logs. Valid values are:
ENABLED: S3 build logs are enabled for this build project.DISABLED: S3 build logs are not enabled for this build project.
- encryption
Disabled boolean - Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.
- location string
- The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is
my-bucket, and your path prefix isbuild-log, then acceptable formats aremy-bucket/build-logorarn:aws:s3:::my-bucket/build-log.
- status str
- The current status of the S3 build logs. Valid values are:
ENABLED: S3 build logs are enabled for this build project.DISABLED: S3 build logs are not enabled for this build project.
- encryption_
disabled bool - Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.
- location str
- The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is
my-bucket, and your path prefix isbuild-log, then acceptable formats aremy-bucket/build-logorarn:aws:s3:::my-bucket/build-log.
- status String
- The current status of the S3 build logs. Valid values are:
ENABLED: S3 build logs are enabled for this build project.DISABLED: S3 build logs are not enabled for this build project.
- encryption
Disabled Boolean - Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.
- location String
- The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is
my-bucket, and your path prefix isbuild-log, then acceptable formats aremy-bucket/build-logorarn:aws:s3:::my-bucket/build-log.
ProjectSource
- Type string
- The type of repository that contains the source code to be built. Valid values include:
BITBUCKET: The source code is in a Bitbucket repository.CODECOMMIT: The source code is in an CodeCommit repository.CODEPIPELINE: The source code settings are specified in the source action of a pipeline in CodePipeline.GITHUB: The source code is in a GitHub repository.GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise Server repository.GITLAB: The source code is in a GitLab repository.GITLAB_SELF_MANAGED: The source code is in a self-managed GitLab repository.NO_SOURCE: The project does not have input source code.S3: The source code is in an Amazon S3 bucket.
- Auth
Pulumi.
Aws Native. Code Build. Inputs. Project Source Auth - Information about the authorization settings for AWS CodeBuild to access the source code to be built.
- Build
Spec string - The build specification for the project. If this value is not provided, then the source code must contain a buildspec file named
buildspec.ymlat the root level. If this value is provided, it can be either a single string containing the entire build specification, or the path to an alternate buildspec file relative to the value of the built-in environment variableCODEBUILD_SRC_DIR. The alternate buildspec file can have a name other thanbuildspec.yml, for examplemyspec.ymlorbuild_spec_qa.ymlor similar. For more information, see the Build Spec Reference in the AWS CodeBuild User Guide . - Build
Status Pulumi.Config Aws Native. Code Build. Inputs. Project Build Status Config - Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is
GITHUB,GITHUB_ENTERPRISE, orBITBUCKET. - Git
Clone intDepth - The depth of history to download. Minimum value is 0. If this value is 0, greater than 25, or not provided, then the full history is downloaded with each build project. If your source type is Amazon S3, this value is not supported.
- Git
Submodules Pulumi.Config Aws Native. Code Build. Inputs. Project Git Submodules Config - Information about the Git submodules configuration for the build project.
- Insecure
Ssl bool - This is used with GitHub Enterprise only. Set to true to ignore SSL warnings while connecting to your GitHub Enterprise project repository. The default value is
false.InsecureSslshould be used for testing purposes only. It should not be used in a production environment. - Location string
Information about the location of the source code to be built. Valid values include:
For source code settings that are specified in the source action of a pipeline in CodePipeline,
locationshould not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example,
https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>).For source code in an Amazon S3 input bucket, one of the following.
The path to the ZIP file that contains the source code (for example,
<bucket-name>/<path>/<object-name>.zip).The path to the folder that contains the source code (for example,
<bucket-name>/<path-to-source-code>/<folder>/).For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access , choose Request access next to each repository you want to allow AWS CodeBuild to have access to, and then choose Authorize application . (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the
sourceobject, set theauthobject'stypevalue toOAUTH.For source code in an GitLab or self-managed GitLab repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your GitLab account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitLab, on the Connections Authorize application page, choose Authorize . Then on the AWS CodeConnections Create GitLab connection page, choose Connect to GitLab . (After you have connected to your GitLab account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to override the default connection and use this connection instead, set the
authobject'stypevalue toCODECONNECTIONSin thesourceobject.For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access . (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the
sourceobject, set theauthobject'stypevalue toOAUTH.
If you specify
CODEPIPELINEfor theTypeproperty, don't specify this property. For all of the other types, you must specifyLocation.- Report
Build boolStatus - Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket. If this is set and you use a different source provider, an
invalidInputExceptionis thrown. - Source
Identifier string - An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.
- Type string
- The type of repository that contains the source code to be built. Valid values include:
BITBUCKET: The source code is in a Bitbucket repository.CODECOMMIT: The source code is in an CodeCommit repository.CODEPIPELINE: The source code settings are specified in the source action of a pipeline in CodePipeline.GITHUB: The source code is in a GitHub repository.GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise Server repository.GITLAB: The source code is in a GitLab repository.GITLAB_SELF_MANAGED: The source code is in a self-managed GitLab repository.NO_SOURCE: The project does not have input source code.S3: The source code is in an Amazon S3 bucket.
- Auth
Project
Source Auth - Information about the authorization settings for AWS CodeBuild to access the source code to be built.
- Build
Spec string - The build specification for the project. If this value is not provided, then the source code must contain a buildspec file named
buildspec.ymlat the root level. If this value is provided, it can be either a single string containing the entire build specification, or the path to an alternate buildspec file relative to the value of the built-in environment variableCODEBUILD_SRC_DIR. The alternate buildspec file can have a name other thanbuildspec.yml, for examplemyspec.ymlorbuild_spec_qa.ymlor similar. For more information, see the Build Spec Reference in the AWS CodeBuild User Guide . - Build
Status ProjectConfig Build Status Config - Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is
GITHUB,GITHUB_ENTERPRISE, orBITBUCKET. - Git
Clone intDepth - The depth of history to download. Minimum value is 0. If this value is 0, greater than 25, or not provided, then the full history is downloaded with each build project. If your source type is Amazon S3, this value is not supported.
- Git
Submodules ProjectConfig Git Submodules Config - Information about the Git submodules configuration for the build project.
- Insecure
Ssl bool - This is used with GitHub Enterprise only. Set to true to ignore SSL warnings while connecting to your GitHub Enterprise project repository. The default value is
false.InsecureSslshould be used for testing purposes only. It should not be used in a production environment. - Location string
Information about the location of the source code to be built. Valid values include:
For source code settings that are specified in the source action of a pipeline in CodePipeline,
locationshould not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example,
https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>).For source code in an Amazon S3 input bucket, one of the following.
The path to the ZIP file that contains the source code (for example,
<bucket-name>/<path>/<object-name>.zip).The path to the folder that contains the source code (for example,
<bucket-name>/<path-to-source-code>/<folder>/).For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access , choose Request access next to each repository you want to allow AWS CodeBuild to have access to, and then choose Authorize application . (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the
sourceobject, set theauthobject'stypevalue toOAUTH.For source code in an GitLab or self-managed GitLab repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your GitLab account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitLab, on the Connections Authorize application page, choose Authorize . Then on the AWS CodeConnections Create GitLab connection page, choose Connect to GitLab . (After you have connected to your GitLab account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to override the default connection and use this connection instead, set the
authobject'stypevalue toCODECONNECTIONSin thesourceobject.For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access . (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the
sourceobject, set theauthobject'stypevalue toOAUTH.
If you specify
CODEPIPELINEfor theTypeproperty, don't specify this property. For all of the other types, you must specifyLocation.- Report
Build boolStatus - Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket. If this is set and you use a different source provider, an
invalidInputExceptionis thrown. - Source
Identifier string - An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.
- type string
- The type of repository that contains the source code to be built. Valid values include:
BITBUCKET: The source code is in a Bitbucket repository.CODECOMMIT: The source code is in an CodeCommit repository.CODEPIPELINE: The source code settings are specified in the source action of a pipeline in CodePipeline.GITHUB: The source code is in a GitHub repository.GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise Server repository.GITLAB: The source code is in a GitLab repository.GITLAB_SELF_MANAGED: The source code is in a self-managed GitLab repository.NO_SOURCE: The project does not have input source code.S3: The source code is in an Amazon S3 bucket.
- auth object
- Information about the authorization settings for AWS CodeBuild to access the source code to be built.
- build_
spec string - The build specification for the project. If this value is not provided, then the source code must contain a buildspec file named
buildspec.ymlat the root level. If this value is provided, it can be either a single string containing the entire build specification, or the path to an alternate buildspec file relative to the value of the built-in environment variableCODEBUILD_SRC_DIR. The alternate buildspec file can have a name other thanbuildspec.yml, for examplemyspec.ymlorbuild_spec_qa.ymlor similar. For more information, see the Build Spec Reference in the AWS CodeBuild User Guide . - build_
status_ objectconfig - Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is
GITHUB,GITHUB_ENTERPRISE, orBITBUCKET. - git_
clone_ numberdepth - The depth of history to download. Minimum value is 0. If this value is 0, greater than 25, or not provided, then the full history is downloaded with each build project. If your source type is Amazon S3, this value is not supported.
- git_
submodules_ objectconfig - Information about the Git submodules configuration for the build project.
- insecure_
ssl bool - This is used with GitHub Enterprise only. Set to true to ignore SSL warnings while connecting to your GitHub Enterprise project repository. The default value is
false.InsecureSslshould be used for testing purposes only. It should not be used in a production environment. - location string
Information about the location of the source code to be built. Valid values include:
For source code settings that are specified in the source action of a pipeline in CodePipeline,
locationshould not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example,
https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>).For source code in an Amazon S3 input bucket, one of the following.
The path to the ZIP file that contains the source code (for example,
<bucket-name>/<path>/<object-name>.zip).The path to the folder that contains the source code (for example,
<bucket-name>/<path-to-source-code>/<folder>/).For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access , choose Request access next to each repository you want to allow AWS CodeBuild to have access to, and then choose Authorize application . (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the
sourceobject, set theauthobject'stypevalue toOAUTH.For source code in an GitLab or self-managed GitLab repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your GitLab account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitLab, on the Connections Authorize application page, choose Authorize . Then on the AWS CodeConnections Create GitLab connection page, choose Connect to GitLab . (After you have connected to your GitLab account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to override the default connection and use this connection instead, set the
authobject'stypevalue toCODECONNECTIONSin thesourceobject.For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access . (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the
sourceobject, set theauthobject'stypevalue toOAUTH.
If you specify
CODEPIPELINEfor theTypeproperty, don't specify this property. For all of the other types, you must specifyLocation.- report_
build_ boolstatus - Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket. If this is set and you use a different source provider, an
invalidInputExceptionis thrown. - source_
identifier string - An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.
- type String
- The type of repository that contains the source code to be built. Valid values include:
BITBUCKET: The source code is in a Bitbucket repository.CODECOMMIT: The source code is in an CodeCommit repository.CODEPIPELINE: The source code settings are specified in the source action of a pipeline in CodePipeline.GITHUB: The source code is in a GitHub repository.GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise Server repository.GITLAB: The source code is in a GitLab repository.GITLAB_SELF_MANAGED: The source code is in a self-managed GitLab repository.NO_SOURCE: The project does not have input source code.S3: The source code is in an Amazon S3 bucket.
- auth
Project
Source Auth - Information about the authorization settings for AWS CodeBuild to access the source code to be built.
- build
Spec String - The build specification for the project. If this value is not provided, then the source code must contain a buildspec file named
buildspec.ymlat the root level. If this value is provided, it can be either a single string containing the entire build specification, or the path to an alternate buildspec file relative to the value of the built-in environment variableCODEBUILD_SRC_DIR. The alternate buildspec file can have a name other thanbuildspec.yml, for examplemyspec.ymlorbuild_spec_qa.ymlor similar. For more information, see the Build Spec Reference in the AWS CodeBuild User Guide . - build
Status ProjectConfig Build Status Config - Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is
GITHUB,GITHUB_ENTERPRISE, orBITBUCKET. - git
Clone IntegerDepth - The depth of history to download. Minimum value is 0. If this value is 0, greater than 25, or not provided, then the full history is downloaded with each build project. If your source type is Amazon S3, this value is not supported.
- git
Submodules ProjectConfig Git Submodules Config - Information about the Git submodules configuration for the build project.
- insecure
Ssl Boolean - This is used with GitHub Enterprise only. Set to true to ignore SSL warnings while connecting to your GitHub Enterprise project repository. The default value is
false.InsecureSslshould be used for testing purposes only. It should not be used in a production environment. - location String
Information about the location of the source code to be built. Valid values include:
For source code settings that are specified in the source action of a pipeline in CodePipeline,
locationshould not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example,
https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>).For source code in an Amazon S3 input bucket, one of the following.
The path to the ZIP file that contains the source code (for example,
<bucket-name>/<path>/<object-name>.zip).The path to the folder that contains the source code (for example,
<bucket-name>/<path-to-source-code>/<folder>/).For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access , choose Request access next to each repository you want to allow AWS CodeBuild to have access to, and then choose Authorize application . (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the
sourceobject, set theauthobject'stypevalue toOAUTH.For source code in an GitLab or self-managed GitLab repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your GitLab account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitLab, on the Connections Authorize application page, choose Authorize . Then on the AWS CodeConnections Create GitLab connection page, choose Connect to GitLab . (After you have connected to your GitLab account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to override the default connection and use this connection instead, set the
authobject'stypevalue toCODECONNECTIONSin thesourceobject.For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access . (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the
sourceobject, set theauthobject'stypevalue toOAUTH.
If you specify
CODEPIPELINEfor theTypeproperty, don't specify this property. For all of the other types, you must specifyLocation.- report
Build BooleanStatus - Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket. If this is set and you use a different source provider, an
invalidInputExceptionis thrown. - source
Identifier String - An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.
- type string
- The type of repository that contains the source code to be built. Valid values include:
BITBUCKET: The source code is in a Bitbucket repository.CODECOMMIT: The source code is in an CodeCommit repository.CODEPIPELINE: The source code settings are specified in the source action of a pipeline in CodePipeline.GITHUB: The source code is in a GitHub repository.GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise Server repository.GITLAB: The source code is in a GitLab repository.GITLAB_SELF_MANAGED: The source code is in a self-managed GitLab repository.NO_SOURCE: The project does not have input source code.S3: The source code is in an Amazon S3 bucket.
- auth
Project
Source Auth - Information about the authorization settings for AWS CodeBuild to access the source code to be built.
- build
Spec string - The build specification for the project. If this value is not provided, then the source code must contain a buildspec file named
buildspec.ymlat the root level. If this value is provided, it can be either a single string containing the entire build specification, or the path to an alternate buildspec file relative to the value of the built-in environment variableCODEBUILD_SRC_DIR. The alternate buildspec file can have a name other thanbuildspec.yml, for examplemyspec.ymlorbuild_spec_qa.ymlor similar. For more information, see the Build Spec Reference in the AWS CodeBuild User Guide . - build
Status ProjectConfig Build Status Config - Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is
GITHUB,GITHUB_ENTERPRISE, orBITBUCKET. - git
Clone numberDepth - The depth of history to download. Minimum value is 0. If this value is 0, greater than 25, or not provided, then the full history is downloaded with each build project. If your source type is Amazon S3, this value is not supported.
- git
Submodules ProjectConfig Git Submodules Config - Information about the Git submodules configuration for the build project.
- insecure
Ssl boolean - This is used with GitHub Enterprise only. Set to true to ignore SSL warnings while connecting to your GitHub Enterprise project repository. The default value is
false.InsecureSslshould be used for testing purposes only. It should not be used in a production environment. - location string
Information about the location of the source code to be built. Valid values include:
For source code settings that are specified in the source action of a pipeline in CodePipeline,
locationshould not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example,
https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>).For source code in an Amazon S3 input bucket, one of the following.
The path to the ZIP file that contains the source code (for example,
<bucket-name>/<path>/<object-name>.zip).The path to the folder that contains the source code (for example,
<bucket-name>/<path-to-source-code>/<folder>/).For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access , choose Request access next to each repository you want to allow AWS CodeBuild to have access to, and then choose Authorize application . (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the
sourceobject, set theauthobject'stypevalue toOAUTH.For source code in an GitLab or self-managed GitLab repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your GitLab account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitLab, on the Connections Authorize application page, choose Authorize . Then on the AWS CodeConnections Create GitLab connection page, choose Connect to GitLab . (After you have connected to your GitLab account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to override the default connection and use this connection instead, set the
authobject'stypevalue toCODECONNECTIONSin thesourceobject.For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access . (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the
sourceobject, set theauthobject'stypevalue toOAUTH.
If you specify
CODEPIPELINEfor theTypeproperty, don't specify this property. For all of the other types, you must specifyLocation.- report
Build booleanStatus - Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket. If this is set and you use a different source provider, an
invalidInputExceptionis thrown. - source
Identifier string - An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.
- type str
- The type of repository that contains the source code to be built. Valid values include:
BITBUCKET: The source code is in a Bitbucket repository.CODECOMMIT: The source code is in an CodeCommit repository.CODEPIPELINE: The source code settings are specified in the source action of a pipeline in CodePipeline.GITHUB: The source code is in a GitHub repository.GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise Server repository.GITLAB: The source code is in a GitLab repository.GITLAB_SELF_MANAGED: The source code is in a self-managed GitLab repository.NO_SOURCE: The project does not have input source code.S3: The source code is in an Amazon S3 bucket.
- auth
Project
Source Auth - Information about the authorization settings for AWS CodeBuild to access the source code to be built.
- build_
spec str - The build specification for the project. If this value is not provided, then the source code must contain a buildspec file named
buildspec.ymlat the root level. If this value is provided, it can be either a single string containing the entire build specification, or the path to an alternate buildspec file relative to the value of the built-in environment variableCODEBUILD_SRC_DIR. The alternate buildspec file can have a name other thanbuildspec.yml, for examplemyspec.ymlorbuild_spec_qa.ymlor similar. For more information, see the Build Spec Reference in the AWS CodeBuild User Guide . - build_
status_ Projectconfig Build Status Config - Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is
GITHUB,GITHUB_ENTERPRISE, orBITBUCKET. - git_
clone_ intdepth - The depth of history to download. Minimum value is 0. If this value is 0, greater than 25, or not provided, then the full history is downloaded with each build project. If your source type is Amazon S3, this value is not supported.
- git_
submodules_ Projectconfig Git Submodules Config - Information about the Git submodules configuration for the build project.
- insecure_
ssl bool - This is used with GitHub Enterprise only. Set to true to ignore SSL warnings while connecting to your GitHub Enterprise project repository. The default value is
false.InsecureSslshould be used for testing purposes only. It should not be used in a production environment. - location str
Information about the location of the source code to be built. Valid values include:
For source code settings that are specified in the source action of a pipeline in CodePipeline,
locationshould not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example,
https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>).For source code in an Amazon S3 input bucket, one of the following.
The path to the ZIP file that contains the source code (for example,
<bucket-name>/<path>/<object-name>.zip).The path to the folder that contains the source code (for example,
<bucket-name>/<path-to-source-code>/<folder>/).For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access , choose Request access next to each repository you want to allow AWS CodeBuild to have access to, and then choose Authorize application . (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the
sourceobject, set theauthobject'stypevalue toOAUTH.For source code in an GitLab or self-managed GitLab repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your GitLab account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitLab, on the Connections Authorize application page, choose Authorize . Then on the AWS CodeConnections Create GitLab connection page, choose Connect to GitLab . (After you have connected to your GitLab account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to override the default connection and use this connection instead, set the
authobject'stypevalue toCODECONNECTIONSin thesourceobject.For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access . (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the
sourceobject, set theauthobject'stypevalue toOAUTH.
If you specify
CODEPIPELINEfor theTypeproperty, don't specify this property. For all of the other types, you must specifyLocation.- report_
build_ boolstatus - Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket. If this is set and you use a different source provider, an
invalidInputExceptionis thrown. - source_
identifier str - An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.
- type String
- The type of repository that contains the source code to be built. Valid values include:
BITBUCKET: The source code is in a Bitbucket repository.CODECOMMIT: The source code is in an CodeCommit repository.CODEPIPELINE: The source code settings are specified in the source action of a pipeline in CodePipeline.GITHUB: The source code is in a GitHub repository.GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise Server repository.GITLAB: The source code is in a GitLab repository.GITLAB_SELF_MANAGED: The source code is in a self-managed GitLab repository.NO_SOURCE: The project does not have input source code.S3: The source code is in an Amazon S3 bucket.
- auth Property Map
- Information about the authorization settings for AWS CodeBuild to access the source code to be built.
- build
Spec String - The build specification for the project. If this value is not provided, then the source code must contain a buildspec file named
buildspec.ymlat the root level. If this value is provided, it can be either a single string containing the entire build specification, or the path to an alternate buildspec file relative to the value of the built-in environment variableCODEBUILD_SRC_DIR. The alternate buildspec file can have a name other thanbuildspec.yml, for examplemyspec.ymlorbuild_spec_qa.ymlor similar. For more information, see the Build Spec Reference in the AWS CodeBuild User Guide . - build
Status Property MapConfig - Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is
GITHUB,GITHUB_ENTERPRISE, orBITBUCKET. - git
Clone NumberDepth - The depth of history to download. Minimum value is 0. If this value is 0, greater than 25, or not provided, then the full history is downloaded with each build project. If your source type is Amazon S3, this value is not supported.
- git
Submodules Property MapConfig - Information about the Git submodules configuration for the build project.
- insecure
Ssl Boolean - This is used with GitHub Enterprise only. Set to true to ignore SSL warnings while connecting to your GitHub Enterprise project repository. The default value is
false.InsecureSslshould be used for testing purposes only. It should not be used in a production environment. - location String
Information about the location of the source code to be built. Valid values include:
For source code settings that are specified in the source action of a pipeline in CodePipeline,
locationshould not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example,
https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>).For source code in an Amazon S3 input bucket, one of the following.
The path to the ZIP file that contains the source code (for example,
<bucket-name>/<path>/<object-name>.zip).The path to the folder that contains the source code (for example,
<bucket-name>/<path-to-source-code>/<folder>/).For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access , choose Request access next to each repository you want to allow AWS CodeBuild to have access to, and then choose Authorize application . (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the
sourceobject, set theauthobject'stypevalue toOAUTH.For source code in an GitLab or self-managed GitLab repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your GitLab account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitLab, on the Connections Authorize application page, choose Authorize . Then on the AWS CodeConnections Create GitLab connection page, choose Connect to GitLab . (After you have connected to your GitLab account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to override the default connection and use this connection instead, set the
authobject'stypevalue toCODECONNECTIONSin thesourceobject.For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access . (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the
sourceobject, set theauthobject'stypevalue toOAUTH.
If you specify
CODEPIPELINEfor theTypeproperty, don't specify this property. For all of the other types, you must specifyLocation.- report
Build BooleanStatus - Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket. If this is set and you use a different source provider, an
invalidInputExceptionis thrown. - source
Identifier String - An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.
ProjectSourceAuth
ProjectSourceVersion
- Source
Identifier string - An identifier for a source in the build project. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.
- Source
Version string The source version for the corresponding source identifier. If specified, 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 GitLab: the commit ID, branch, or Git tag to use.
- 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.
For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide .
- Source
Identifier string - An identifier for a source in the build project. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.
- Source
Version string The source version for the corresponding source identifier. If specified, 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 GitLab: the commit ID, branch, or Git tag to use.
- 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.
For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide .
- source_
identifier string - An identifier for a source in the build project. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.
- source_
version string The source version for the corresponding source identifier. If specified, 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 GitLab: the commit ID, branch, or Git tag to use.
- 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.
For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide .
- source
Identifier String - An identifier for a source in the build project. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.
- source
Version String The source version for the corresponding source identifier. If specified, 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 GitLab: the commit ID, branch, or Git tag to use.
- 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.
For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide .
- source
Identifier string - An identifier for a source in the build project. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.
- source
Version string The source version for the corresponding source identifier. If specified, 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 GitLab: the commit ID, branch, or Git tag to use.
- 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.
For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide .
- source_
identifier str - An identifier for a source in the build project. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.
- source_
version str The source version for the corresponding source identifier. If specified, 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 GitLab: the commit ID, branch, or Git tag to use.
- 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.
For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide .
- source
Identifier String - An identifier for a source in the build project. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.
- source
Version String The source version for the corresponding source identifier. If specified, 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 GitLab: the commit ID, branch, or Git tag to use.
- 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.
For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide .
ProjectVpcConfig
- Security
Group List<string>Ids - A list of one or more security groups IDs in your Amazon VPC. The maximum count is 5.
- Subnets List<string>
- A list of one or more subnet IDs in your Amazon VPC. The maximum count is 16.
- Vpc
Id string - The ID of the Amazon VPC.
- Security
Group []stringIds - A list of one or more security groups IDs in your Amazon VPC. The maximum count is 5.
- Subnets []string
- A list of one or more subnet IDs in your Amazon VPC. The maximum count is 16.
- Vpc
Id string - The ID of the Amazon VPC.
- security_
group_ list(string)ids - A list of one or more security groups IDs in your Amazon VPC. The maximum count is 5.
- subnets list(string)
- A list of one or more subnet IDs in your Amazon VPC. The maximum count is 16.
- vpc_
id string - The ID of the Amazon VPC.
- security
Group List<String>Ids - A list of one or more security groups IDs in your Amazon VPC. The maximum count is 5.
- subnets List<String>
- A list of one or more subnet IDs in your Amazon VPC. The maximum count is 16.
- vpc
Id String - The ID of the Amazon VPC.
- security
Group string[]Ids - A list of one or more security groups IDs in your Amazon VPC. The maximum count is 5.
- subnets string[]
- A list of one or more subnet IDs in your Amazon VPC. The maximum count is 16.
- vpc
Id string - The ID of the Amazon VPC.
- security_
group_ Sequence[str]ids - A list of one or more security groups IDs in your Amazon VPC. The maximum count is 5.
- subnets Sequence[str]
- A list of one or more subnet IDs in your Amazon VPC. The maximum count is 16.
- vpc_
id str - The ID of the Amazon VPC.
- security
Group List<String>Ids - A list of one or more security groups IDs in your Amazon VPC. The maximum count is 5.
- subnets List<String>
- A list of one or more subnet IDs in your Amazon VPC. The maximum count is 16.
- vpc
Id String - The ID of the Amazon VPC.
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi