AWS CDK Reference

Appearance

v2.274.0

ProjectProps Struct ​

Source
aws-codebuild/lib/project.ts

Example ​

ts
declare const ecrRepository: ecr.Repository;

new codebuild.Project(this, 'Project', {
  environment: {
    buildImage: codebuild.WindowsBuildImage.fromEcrRepository(ecrRepository, 'v1.0', codebuild.WindowsImageType.SERVER_2019),
    // optional certificate to include in the build image
    certificate: {
      bucket: s3.Bucket.fromBucketName(this, 'Bucket', 'amzn-s3-demo-bucket'),
      objectKey: 'path/to/cert.pem',
    },
  },
  // ...
})

Properties ​

allowAllOutboundbooleanallow_all_outboundboolallowAllOutboundBooleanAllowAllOutboundboolAllowAllOutbound*bool= true#
Whether to allow the CodeBuild to send all network traffic.

If set to false, you must individually add traffic rules to allow the CodeBuild project to connect to network targets.

Only used if 'vpc' is supplied.

artifactsIArtifactsartifactsIArtifactsartifactsIArtifactsArtifactsIArtifactsArtifactsIArtifacts= NoArtifacts#
Defines where build artifacts will be stored.

Could be: PipelineBuildArtifacts, NoArtifacts and S3Artifacts.

autoRetryLimitnumberauto_retry_limitint | floatautoRetryLimitNumberAutoRetryLimitdoubleAutoRetryLimit*float64= no retry#
CodeBuild will automatically call retry build using the project's service role up to the auto-retry limit.

autoRetryLimit must be between 0 and 10.

badgebooleanbadgeboolbadgeBooleanBadgeboolBadge*bool= false#
Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.

For more information, see Build Badges Sample in the AWS CodeBuild User Guide.

buildSpecBuildSpecbuild_specBuildSpecbuildSpecBuildSpecBuildSpecBuildSpecBuildSpecBuildSpec= Empty buildspec.#
Filename or contents of buildspec in JSON format.
cacheCachecacheCachecacheCacheCacheCacheCacheCache= Cache.none#
Caching strategy to use.
checkSecretsInPlainTextEnvVariablesbooleancheck_secrets_in_plain_text_env_variablesboolcheckSecretsInPlainTextEnvVariablesBooleanCheckSecretsInPlainTextEnvVariablesboolCheckSecretsInPlainTextEnvVariables*bool= true#
Whether to check for the presence of any secrets in the environment variables of the default type, BuildEnvironmentVariableType.PLAINTEXT. Since using a secret for the value of that kind of variable would result in it being displayed in plain text in the AWS Console, the construct will throw an exception if it detects a secret was passed there. Pass this property as false if you want to skip this validation, and keep using a secret in a plain text environment variable.
concurrentBuildLimitnumberconcurrent_build_limitint | floatconcurrentBuildLimitNumberConcurrentBuildLimitdoubleConcurrentBuildLimit*float64= no explicit limit is set#
Maximum number of concurrent builds.

Minimum value is 1 and maximum is account build limit.

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= No description.#
A description of the project.

Use the description to identify the purpose of the project.

encryptionKeyIKeyencryption_keyIKeyencryptionKeyIKeyEncryptionKeyIKeyEncryptionKeyIKey= The AWS-managed CMK for Amazon S…#
Encryption key to use to read and write artifacts.
default

Default: The AWS-managed CMK for Amazon Simple Storage Service (Amazon S3) is used.

environmentBuildEnvironmentenvironmentBuildEnvironmentenvironmentBuildEnvironmentEnvironmentBuildEnvironmentEnvironmentBuildEnvironment= BuildEnvironment.LinuxBuildImage…#
Build environment to use for the build.
default

Default: BuildEnvironment.LinuxBuildImage.STANDARD_7_0

environmentVariables{ [key: string]: BuildEnvironmentVariable }environment_variablestyping.Mapping[str, BuildEnvironmentVariable]environmentVariablesMap<String, BuildEnvironmentVariable>EnvironmentVariablesIDictionary<string, BuildEnvironmentVariable>EnvironmentVariables*map[string]BuildEnvironmentVariable= No additional environment variab…#
Additional environment variables to add to the build environment.
default

Default: No additional environment variables are specified.

fileSystemLocationsIFileSystemLocation[]file_system_locationstyping.List[IFileSystemLocation]fileSystemLocationsList<IFileSystemLocation>FileSystemLocationsIFileSystemLocation[]FileSystemLocations*[]IFileSystemLocation= no file system locations#
An 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.

grantReportGroupPermissionsbooleangrant_report_group_permissionsboolgrantReportGroupPermissionsBooleanGrantReportGroupPermissionsboolGrantReportGroupPermissions*bool= true#
Add permissions to this project's role to create and use test report groups with name starting with the name of this project.
notes

That is the standard report group that gets created when a simple name (in contrast to an ARN) is used in the 'reports' section of the buildspec of this project. This is usually harmless, but you can turn these off if you don't plan on using test reports in this project.

loggingLoggingOptionsloggingLoggingOptionsloggingLoggingOptionsLoggingLoggingOptionsLoggingLoggingOptions= no log configuration is set#
Information about logs for the build project.

A project can create logs in Amazon CloudWatch Logs, an S3 bucket, or both.

projectNamestringproject_namestrprojectNameStringProjectNamestringProjectName*string= Name is automatically generated.#
The physical, human-readable name of the CodeBuild Project.
queuedTimeoutDurationqueued_timeoutDurationqueuedTimeoutDurationQueuedTimeoutDurationQueuedTimeoutDuration= no queue timeout is set#
The number of minutes after which AWS CodeBuild stops the build if it's still in queue.

For valid values, see the timeoutInMinutes field in the AWS CodeBuild User Guide.

roleIRoleroleIRoleroleIRoleRoleIRoleRoleIRole= A role will be created.#
Service Role to assume while running the build.
secondaryArtifactsIArtifacts[]secondary_artifactstyping.List[IArtifacts]secondaryArtifactsList<IArtifacts>SecondaryArtifactsIArtifacts[]SecondaryArtifacts*[]IArtifacts= No secondary artifacts.#
The secondary artifacts for the Project.

Can also be added after the Project has been created by using the Project#addSecondaryArtifact method.

secondarySourcesISource[]secondary_sourcestyping.List[ISource]secondarySourcesList<ISource>SecondarySourcesISource[]SecondarySources*[]ISource= No secondary sources.#
The secondary sources for the Project.

Can be also added after the Project has been created by using the Project#addSecondarySource method.

securityGroupsISecurityGroup[]security_groupstyping.List[ISecurityGroup]securityGroupsList<ISecurityGroup>SecurityGroupsISecurityGroup[]SecurityGroups*[]ISecurityGroup= Security group will be automatic…#
What security group to associate with the codebuild project's network interfaces.

If no security group is identified, one will be created automatically.

Only used if 'vpc' is supplied.

default

Default: Security group will be automatically created.

sourceISourcesourceISourcesourceISourceSourceISourceSourceISource= NoSource#
The source of the build.

Note: if NoSource is given as the source, then you need to provide an explicit buildSpec.

ssmSessionPermissionsbooleanssm_session_permissionsboolssmSessionPermissionsBooleanSsmSessionPermissionsboolSsmSessionPermissions*bool= false#
Add the permissions necessary for debugging builds with SSM Session Manager.
notes

If the following prerequisites have been met:

  • The necessary permissions have been added by setting this flag to true.
  • The build image has the SSM agent installed (true for default CodeBuild images).
  • The build is started with debugSessionEnabled set to true.

Then the build container can be paused and inspected using Session Manager by invoking the codebuild-breakpoint command somewhere during the build.

codebuild-breakpoint commands will be ignored if the build is not started with debugSessionEnabled=true.

subnetSelectionSubnetSelectionsubnet_selectionSubnetSelectionsubnetSelectionSubnetSelectionSubnetSelectionSubnetSelectionSubnetSelectionSubnetSelection= private subnets if available els…#
Where to place the network interfaces within the VPC.
notes · default

To access AWS services, your CodeBuild project needs to be in one of the following types of subnets:

  1. Subnets with access to the internet (of type PRIVATE_WITH_EGRESS).
  2. Private subnets unconnected to the internet, but with VPC endpoints for the necessary services.

If you don't specify a subnet selection, the default behavior is to use PRIVATE_WITH_EGRESS subnets first if they exist, then PRIVATE_WITHOUT_EGRESS, and finally PUBLIC subnets. If your VPC doesn't have PRIVATE_WITH_EGRESS subnets but you need AWS service access, add VPC Endpoints to your private subnets.

Default: private subnets if available else public subnets

timeoutDurationtimeoutDurationtimeoutDurationTimeoutDurationTimeoutDuration= Duration.hours(1)#
The number of minutes after which AWS CodeBuild stops the build if it's not complete.

For valid values, see the timeoutInMinutes field in the AWS CodeBuild User Guide.

visibilityProjectVisibilityvisibilityProjectVisibilityvisibilityProjectVisibilityVisibilityProjectVisibilityVisibilityProjectVisibility= no visibility is set#
Specifies the visibility of the project's builds.
vpcIVpcvpcIVpcvpcIVpcVpcIVpcVpcIVpc= No VPC is specified.#
VPC network to place codebuild network interfaces.

Specify this if the codebuild project needs to access resources in a VPC.