aws_codebuild_project

account_id

Type: STRING

arn

Type: STRING
Provider name: arn
Description: The Amazon Resource Name (ARN) of the build project.

artifacts

Type: STRUCT
Provider name: artifacts
Description: Information about the build output artifacts for the build project.

• artifact_identifier
  Type: STRING
  Provider name: artifactIdentifier
  Description: An identifier for this artifact definition.
  
• bucket_owner_access
  Type: STRING
  Provider name: bucketOwnerAccess
  
• encryption_disabled
  Type: BOOLEAN
  Provider name: encryptionDisabled
  Description: Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException is thrown.
  
• location
  Type: STRING
  Provider name: location
  Description: Information about the build output artifact location:
  • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild.
  • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
  • If type is set to S3, this is the name of the output bucket.
• name
  Type: STRING
  Provider name: name
  Description: Along with path and namespaceType, the pattern that CodeBuild uses to name and store the output artifact:
  • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.
  • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
  • If type is set to S3, 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 path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.
  • If path is empty, namespaceType is set to NONE, and name is set to “/”, the output artifact is stored in the root of the output bucket.
  • If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to “/”, the output artifact is stored in MyArtifacts/<build-ID>.
• namespace_type
  Type: STRING
  Provider name: namespaceType
  Description: Along with path and name, the pattern that CodeBuild uses to determine the name and location to store the output artifact:
  • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.
  • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
  • If type is set to S3, 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 if namespaceType is not specified.
  For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.
  
• override_artifact_name
  Type: BOOLEAN
  Provider name: overrideArtifactName
  Description: If this flag is set, 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
  Type: STRING
  Provider name: packaging
  Description: The type of build output artifact to create:
  • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild.
  • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
  • If type is set to S3, valid values include:
    • NONE: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.
    • ZIP: CodeBuild creates in the output bucket a ZIP file that contains the build output.
• path
  Type: STRING
  Provider name: path
  Description: Along with namespaceType and name, the pattern that CodeBuild uses to name and store the output artifact:
  • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.
  • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
  • If type is set to S3, this is the path to the output artifact. If path is not specified, path is not used.
  For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the output bucket at MyArtifacts/MyArtifact.zip.
  
• type
  Type: STRING
  Provider name: type
  Description: The type of build output artifact. Valid values include:
  • CODEPIPELINE: The build project has build output generated through CodePipeline. The CODEPIPELINE type is not supported for secondaryArtifacts.
  • NO_ARTIFACTS: The build project does not produce any build output.
  • S3: The build project stores build output in Amazon S3.

badge

Type: STRUCT
Provider name: badge
Description: Information about the build badge for the build project.

• badge_enabled
  Type: BOOLEAN
  Provider name: badgeEnabled
  Description: Set this to true to generate a publicly accessible URL for your project’s build badge.
  
• badge_request_url
  Type: STRING
  Provider name: badgeRequestUrl
  Description: The publicly-accessible URL through which you can access the build badge for your project.
  

build_batch_config

Type: STRUCT
Provider name: buildBatchConfig
Description: A ProjectBuildBatchConfig object that defines the batch build options for the project.

• batch_report_mode
  Type: STRING
  Provider name: batchReportMode
  Description: 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
  Type: BOOLEAN
  Provider name: combineArtifacts
  Description: Specifies if the build artifacts for the batch build should be combined into a single artifact location.
  
• restrictions
  Type: STRUCT
  Provider name: restrictions
  Description: A BatchRestrictions object that specifies the restrictions for the batch build.
  
  • compute_types_allowed
    Type: UNORDERED_LIST_STRING
    Provider name: computeTypesAllowed
    Description: An array of strings that specify the compute types that are allowed for the batch build. See Build environment compute types in the CodeBuild User Guide for these values.
    
  • maximum_builds_allowed
    Type: INT32
    Provider name: maximumBuildsAllowed
    Description: Specifies the maximum number of builds allowed.
    
• service_role
  Type: STRING
  Provider name: serviceRole
  Description: Specifies the service role ARN for the batch build project.
  
• timeout_in_mins
  Type: INT32
  Provider name: timeoutInMins
  Description: Specifies the maximum amount of time, in minutes, that the batch build must be completed in.
  

cache

Type: STRUCT
Provider name: cache
Description: Information about the cache for the build project.

• location
  Type: STRING
  Provider name: location
  Description: Information about the cache location:
  • NO_CACHE or LOCAL: This value is ignored.
  • S3: This is the S3 bucket name/prefix.
• modes
  Type: UNORDERED_LIST_STRING
  Provider name: modes
  Description: 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 LOCAL cache 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 privileged flag 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
  Type: STRING
  Provider name: type
  Description: The type of cache used by the build project. Valid values include:
  • NO_CACHE: The build project does not use any cache.
  • S3: The build project reads and writes from and to S3.
  • LOCAL: The build project stores a cache locally on a build host that is only available to that build host.

concurrent_build_limit

Type: INT32
Provider name: concurrentBuildLimit
Description: The maximum number of concurrent builds that are allowed for this project. New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.

created

Type: TIMESTAMP
Provider name: created
Description: When the build project was created, expressed in Unix time format.

description

Type: STRING
Provider name: description
Description: A description that makes the build project easy to identify.

encryption_key

Type: STRING
Provider name: encryptionKey
Description: The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK’s alias (using the format alias/<alias-name>). If you don’t specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).

environment

Type: STRUCT
Provider name: environment
Description: Information about the build environment for this build project.

• certificate
  Type: STRING
  Provider name: certificate
  Description: 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 CodeBuild User Guide.
  
• compute_type
  Type: STRING
  Provider name: computeType
  Description: Information about the compute resources the build project uses. Available values include:
  • BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.
  • BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.
  • BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.
  • BUILD_GENERAL1_XLARGE: Use up to 70 GB memory and 36 vCPUs for builds, depending on your environment type.
  • BUILD_GENERAL1_2XLARGE: Use up to 145 GB 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 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
  • BUILD_LAMBDA_2GB: Use up to 2 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
  • BUILD_LAMBDA_4GB: Use up to 4 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
  • BUILD_LAMBDA_8GB: Use up to 8 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
  • BUILD_LAMBDA_10GB: Use up to 10 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
  If you use BUILD_GENERAL1_SMALL:
  • For environment type LINUX_CONTAINER, you can use up to 3 GB memory and 2 vCPUs for builds.
  • For environment type LINUX_GPU_CONTAINER, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
  • For environment type ARM_CONTAINER, you can use up to 4 GB 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 15 GB memory and 8 vCPUs for builds.
  • For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
  • For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.
  If you’re using compute fleets during project creation, computeType will be ignored. For more information, see Build Environment Compute Types in the CodeBuild User Guide.
  
• environment_variables
  Type: UNORDERED_LIST_STRUCT
  Provider name: environmentVariables
  Description: A set of environment variables to make available to builds for this build project.
  
  • name
    Type: STRING
    Provider name: name
    Description: The name or key of the environment variable.
    
  • type
    Type: STRING
    Provider name: type
    Description: 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 the value of 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 CodeBuild User Guide.
    • PLAINTEXT: An environment variable in plain text format. This is the default value.
    • SECRETS_MANAGER: An environment variable stored in Secrets Manager. For environment variables of this type, specify the name of the secret as the value of the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the CodeBuild User Guide.
  • value
    Type: STRING
    Provider name: value
    Description: The value of the environment variable. We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially Amazon Web Services secret key IDs. PLAINTEXT environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.
    
• fleet
  Type: STRUCT
  Provider name: fleet
  Description: A ProjectFleet object to use for this build project.
  
  • fleet_arn
    Type: STRING
    Provider name: fleetArn
    Description: Specifies the compute fleet ARN for the build project.
    
• image
  Type: STRING
  Provider name: image
  Description: 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 be aws/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 CodeBuild user guide.
  
• image_pull_credentials_type
  Type: STRING
  Provider name: imagePullCredentialsType
  Description: The type of credentials CodeBuild uses to pull images in your build. There are two valid values:
  • CODEBUILD specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal.
  • SERVICE_ROLE specifies that 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 CodeBuild curated image, you must use CODEBUILD credentials.
  
• privileged_mode
  Type: BOOLEAN
  Provider name: privilegedMode
  Description: 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 -t argument to timeout: - 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
  Type: STRUCT
  Provider name: registryCredential
  Description: The credentials for access to a private registry.
  
  • credential
    Type: STRING
    Provider name: credential
    Description: The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager. The credential can use the name of the credentials only if they exist in your current Amazon Web Services Region.
    
  • credential_provider
    Type: STRING
    Provider name: credentialProvider
    Description: The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for Secrets Manager.
    
• type
  Type: STRING
  Provider name: type
  Description: The type of build environment to use for related builds.
  • The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and EU (Frankfurt).
  • The environment type LINUX_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).
  • The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia).
  • The environment types ARM_LAMBDA_CONTAINER and LINUX_LAMBDA_CONTAINER are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Mumbai), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), EU (Frankfurt), EU (Ireland), and South America (São Paulo).
  • The environment types WINDOWS_CONTAINER and WINDOWS_SERVER_2019_CONTAINER are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).
  If you’re using compute fleets during project creation, type will be ignored. For more information, see Build environment compute types in the CodeBuild user guide.
  

file_system_locations

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

• identifier
  Type: STRING
  Provider name: identifier
  Description: The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the identifier in all capital letters to CODEBUILD_. For example, if you specify my_efs for identifier, a new environment variable is create named CODEBUILD_MY_EFS. The identifier is used to mount your file system.
  
• location
  Type: STRING
  Provider name: location
  Description: 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 is fs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory is my-efs-mount-directory, then the location is fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory. The directory path in the format efs-dns-name:/directory-path is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.
  
• mount_options
  Type: STRING
  Provider name: mountOptions
  Description: 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.
  
• mount_point
  Type: STRING
  Provider name: mountPoint
  Description: The location in the container where you mount the file system.
  
• type
  Type: STRING
  Provider name: type
  Description: The type of the file system. The one supported type is EFS.
  

last_modified

Type: TIMESTAMP
Provider name: lastModified
Description: When the build project’s settings were last modified, expressed in Unix time format.

logs_config

Type: STRUCT
Provider name: logsConfig
Description: Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both.

• cloud_watch_logs
  Type: STRUCT
  Provider name: cloudWatchLogs
  Description: Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default.
  
  • group_name
    Type: STRING
    Provider name: groupName
    Description: The group name of the logs in CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.
    
  • status
    Type: STRING
    Provider name: status
    Description: 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.
  • stream_name
    Type: STRING
    Provider name: streamName
    Description: The prefix of the stream name of the CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.
    
• s3_logs
  Type: STRUCT
  Provider name: s3Logs
  Description: Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default.
  
  • bucket_owner_access
    Type: STRING
    Provider name: bucketOwnerAccess
    
  • encryption_disabled
    Type: BOOLEAN
    Provider name: encryptionDisabled
    Description: Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.
    
  • location
    Type: STRING
    Provider name: location
    Description: 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 is build-log, then acceptable formats are my-bucket/build-log or arn:aws:s3:::my-bucket/build-log.
    
  • status
    Type: STRING
    Provider name: status
    Description: 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.

name

Type: STRING
Provider name: name
Description: The name of the build project.

project_source

Type: STRUCT
Provider name: source
Description: Information about the build input source code for this build project.

• auth
  Type: STRUCT
  Provider name: auth
  Description: Information about the authorization settings for CodeBuild to access the source code to be built. This information is for the CodeBuild console’s use only. Your code should not get or set this information directly.
  
  • resource
    Type: STRING
    Provider name: resource
    Description: The resource value that applies to the specified authorization type.
    
  • type
    Type: STRING
    Provider name: type
    Description: The authorization type to use. Valid options are OAUTH or CODECONNECTIONS.
    
• build_status_config
  Type: STRUCT
  Provider name: buildStatusConfig
  Description: 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, or BITBUCKET.
  
  • context
    Type: STRING
    Provider name: context
    Description: 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 name parameter 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 context parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.

    
    
  • target_url
    Type: STRING
    Provider name: targetUrl
    Description: 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 url parameter 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_url parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.

    
    
• buildspec
  Type: STRING
  Provider name: buildspec
  Description: The buildspec file declaration to use for the builds in this build project. If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
  
• git_clone_depth
  Type: INT32
  Provider name: gitCloneDepth
  Description: Information about the Git clone depth for the build project.
  
• git_submodules_config
  Type: STRUCT
  Provider name: gitSubmodulesConfig
  Description: Information about the Git submodules configuration for the build project.
  
  • fetch_submodules
    Type: BOOLEAN
    Provider name: fetchSubmodules
    Description: Set to true to fetch Git submodules for your CodeBuild build project.
    
• insecure_ssl
  Type: BOOLEAN
  Provider name: insecureSsl
  Description: Enable this flag to ignore SSL warnings while connecting to the project source code.
  
• location
  Type: STRING
  Provider name: location
  Description: 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, location should 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 Amazon Web Services account to your GitHub account. Use the 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 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 CodeBuild console.) To instruct CodeBuild to use this connection, in the source object, set the auth object’s type value to OAUTH.
  • 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 Amazon Web Services account to your GitLab account. Use the 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 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 CodeBuild console.) To instruct CodeBuild to override the default connection and use this connection instead, set the auth object’s type value to CODECONNECTIONS in the source object.
  • 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 Amazon Web Services account to your Bitbucket account. Use the 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 CodeBuild console.) To instruct CodeBuild to use this connection, in the source object, set the auth object’s type value to OAUTH.
  If you specify CODEPIPELINE for the Type property, don’t specify this property. For all of the other types, you must specify Location.
  
• report_build_status
  Type: BOOLEAN
  Provider name: reportBuildStatus
  Description: 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 invalidInputException is thrown. To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide. The status of a build triggered by a webhook is always reported to your source provider. If your project’s builds are triggered by a webhook, you must push a new commit to the repo for a change to this property to take effect.
  
• source_identifier
  Type: STRING
  Provider name: sourceIdentifier
  Description: 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
  Type: STRING
  Provider name: type
  Description: 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.

project_visibility

Type: STRING
Provider name: projectVisibility

public_project_alias

Type: STRING
Provider name: publicProjectAlias
Description: Contains the project identifier used with the public build APIs.

queued_timeout_in_minutes

Type: INT32
Provider name: queuedTimeoutInMinutes
Description: The number of minutes a build is allowed to be queued before it times out.

resource_access_role

Type: STRING
Provider name: resourceAccessRole
Description: 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

Type: UNORDERED_LIST_STRUCT
Provider name: secondaryArtifacts
Description: An array of ProjectArtifacts objects.

• artifact_identifier
  Type: STRING
  Provider name: artifactIdentifier
  Description: An identifier for this artifact definition.
  
• bucket_owner_access
  Type: STRING
  Provider name: bucketOwnerAccess
  
• encryption_disabled
  Type: BOOLEAN
  Provider name: encryptionDisabled
  Description: Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException is thrown.
  
• location
  Type: STRING
  Provider name: location
  Description: Information about the build output artifact location:
  • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild.
  • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
  • If type is set to S3, this is the name of the output bucket.
• name
  Type: STRING
  Provider name: name
  Description: Along with path and namespaceType, the pattern that CodeBuild uses to name and store the output artifact:
  • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.
  • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
  • If type is set to S3, 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 path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.
  • If path is empty, namespaceType is set to NONE, and name is set to “/”, the output artifact is stored in the root of the output bucket.
  • If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to “/”, the output artifact is stored in MyArtifacts/<build-ID>.
• namespace_type
  Type: STRING
  Provider name: namespaceType
  Description: Along with path and name, the pattern that CodeBuild uses to determine the name and location to store the output artifact:
  • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.
  • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
  • If type is set to S3, 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 if namespaceType is not specified.
  For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.
  
• override_artifact_name
  Type: BOOLEAN
  Provider name: overrideArtifactName
  Description: If this flag is set, 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
  Type: STRING
  Provider name: packaging
  Description: The type of build output artifact to create:
  • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild.
  • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
  • If type is set to S3, valid values include:
    • NONE: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.
    • ZIP: CodeBuild creates in the output bucket a ZIP file that contains the build output.
• path
  Type: STRING
  Provider name: path
  Description: Along with namespaceType and name, the pattern that CodeBuild uses to name and store the output artifact:
  • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.
  • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
  • If type is set to S3, this is the path to the output artifact. If path is not specified, path is not used.
  For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the output bucket at MyArtifacts/MyArtifact.zip.
  
• type
  Type: STRING
  Provider name: type
  Description: The type of build output artifact. Valid values include:
  • CODEPIPELINE: The build project has build output generated through CodePipeline. The CODEPIPELINE type is not supported for secondaryArtifacts.
  • NO_ARTIFACTS: The build project does not produce any build output.
  • S3: The build project stores build output in Amazon S3.

secondary_source_versions

Type: UNORDERED_LIST_STRUCT
Provider name: secondarySourceVersions
Description: An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).

• source_identifier
  Type: STRING
  Provider name: sourceIdentifier
  Description: 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
  Type: STRING
  Provider name: sourceVersion
  Description: 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 CodeBuild User Guide.
  

secondary_sources

Type: UNORDERED_LIST_STRUCT
Provider name: secondarySources
Description: An array of ProjectSource objects.

• auth
  Type: STRUCT
  Provider name: auth
  Description: Information about the authorization settings for CodeBuild to access the source code to be built. This information is for the CodeBuild console’s use only. Your code should not get or set this information directly.
  
  • resource
    Type: STRING
    Provider name: resource
    Description: The resource value that applies to the specified authorization type.
    
  • type
    Type: STRING
    Provider name: type
    Description: The authorization type to use. Valid options are OAUTH or CODECONNECTIONS.
    
• build_status_config
  Type: STRUCT
  Provider name: buildStatusConfig
  Description: 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, or BITBUCKET.
  
  • context
    Type: STRING
    Provider name: context
    Description: 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 name parameter 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 context parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.

    
    
  • target_url
    Type: STRING
    Provider name: targetUrl
    Description: 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 url parameter 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_url parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.

    
    
• buildspec
  Type: STRING
  Provider name: buildspec
  Description: The buildspec file declaration to use for the builds in this build project. If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
  
• git_clone_depth
  Type: INT32
  Provider name: gitCloneDepth
  Description: Information about the Git clone depth for the build project.
  
• git_submodules_config
  Type: STRUCT
  Provider name: gitSubmodulesConfig
  Description: Information about the Git submodules configuration for the build project.
  
  • fetch_submodules
    Type: BOOLEAN
    Provider name: fetchSubmodules
    Description: Set to true to fetch Git submodules for your CodeBuild build project.
    
• insecure_ssl
  Type: BOOLEAN
  Provider name: insecureSsl
  Description: Enable this flag to ignore SSL warnings while connecting to the project source code.
  
• location
  Type: STRING
  Provider name: location
  Description: 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, location should 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 Amazon Web Services account to your GitHub account. Use the 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 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 CodeBuild console.) To instruct CodeBuild to use this connection, in the source object, set the auth object’s type value to OAUTH.
  • 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 Amazon Web Services account to your GitLab account. Use the 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 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 CodeBuild console.) To instruct CodeBuild to override the default connection and use this connection instead, set the auth object’s type value to CODECONNECTIONS in the source object.
  • 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 Amazon Web Services account to your Bitbucket account. Use the 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 CodeBuild console.) To instruct CodeBuild to use this connection, in the source object, set the auth object’s type value to OAUTH.
  If you specify CODEPIPELINE for the Type property, don’t specify this property. For all of the other types, you must specify Location.
  
• report_build_status
  Type: BOOLEAN
  Provider name: reportBuildStatus
  Description: 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 invalidInputException is thrown. To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide. The status of a build triggered by a webhook is always reported to your source provider. If your project’s builds are triggered by a webhook, you must push a new commit to the repo for a change to this property to take effect.
  
• source_identifier
  Type: STRING
  Provider name: sourceIdentifier
  Description: 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
  Type: STRING
  Provider name: type
  Description: 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.

service_role

Type: STRING
Provider name: serviceRole
Description: The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.

source_version

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

• For CodeCommit: the commit ID, branch, or Git tag to use.
• For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch’s HEAD commit ID is used. If not specified, the default branch’s HEAD commit ID is used.
• For 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 sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level). For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

tags

Type: UNORDERED_LIST_STRING

timeout_in_minutes

Type: INT32
Provider name: timeoutInMinutes
Description: How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.

vpc_config

Type: STRUCT
Provider name: vpcConfig
Description: Information about the VPC configuration that CodeBuild accesses.

• security_group_ids
  Type: UNORDERED_LIST_STRING
  Provider name: securityGroupIds
  Description: A list of one or more security groups IDs in your Amazon VPC.
  
• subnets
  Type: UNORDERED_LIST_STRING
  Provider name: subnets
  Description: A list of one or more subnet IDs in your Amazon VPC.
  
• vpc_id
  Type: STRING
  Provider name: vpcId
  Description: The ID of the Amazon VPC.
  

webhook

Type: STRUCT
Provider name: webhook
Description: Information about a webhook that connects repository events to a build project in CodeBuild.

• branch_filter
  Type: STRING
  Provider name: branchFilter
  Description: A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built. It is recommended that you use filterGroups instead of branchFilter.
  
• build_type
  Type: STRING
  Provider name: buildType
  Description: Specifies the type of build this webhook will trigger.
  
• last_modified_secret
  Type: TIMESTAMP
  Provider name: lastModifiedSecret
  Description: A timestamp that indicates the last time a repository’s secret token was modified.
  
• manual_creation
  Type: BOOLEAN
  Provider name: manualCreation
  Description: If manualCreation is true, CodeBuild doesn’t create a webhook in GitHub and instead returns payloadUrl and secret values for the webhook. The payloadUrl and secret values in the output can be used to manually create a webhook within GitHub. manualCreation is only available for GitHub webhooks.
  
• payload_url
  Type: STRING
  Provider name: payloadUrl
  Description: The CodeBuild endpoint where webhook events are sent.
  
• secret
  Type: STRING
  Provider name: secret
  Description: The secret token of the associated repository. A Bitbucket webhook does not support secret.
  
• url
  Type: STRING
  Provider name: url
  Description: The URL to the webhook.