Package software.amazon.awscdk.cfnpropertymixins.services.codebuild

Interface CfnProjectMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProjectMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:57.221Z")
@Stability(Stable)
public interface CfnProjectMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnProjectPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.codebuild.*;
 CfnProjectMixinProps cfnProjectMixinProps = CfnProjectMixinProps.builder()
         .artifacts(ArtifactsProperty.builder()
                 .artifactIdentifier("artifactIdentifier")
                 .encryptionDisabled(false)
                 .location("location")
                 .name("name")
                 .namespaceType("namespaceType")
                 .overrideArtifactName(false)
                 .packaging("packaging")
                 .path("path")
                 .type("type")
                 .build())
         .autoRetryLimit(123)
         .badgeEnabled(false)
         .buildBatchConfig(ProjectBuildBatchConfigProperty.builder()
                 .batchReportMode("batchReportMode")
                 .combineArtifacts(false)
                 .restrictions(BatchRestrictionsProperty.builder()
                         .computeTypesAllowed(List.of("computeTypesAllowed"))
                         .maximumBuildsAllowed(123)
                         .build())
                 .serviceRole("serviceRole")
                 .timeoutInMins(123)
                 .build())
         .cache(ProjectCacheProperty.builder()
                 .cacheNamespace("cacheNamespace")
                 .location("location")
                 .modes(List.of("modes"))
                 .type("type")
                 .build())
         .concurrentBuildLimit(123)
         .description("description")
         .encryptionKey("encryptionKey")
         .environment(EnvironmentProperty.builder()
                 .certificate("certificate")
                 .computeType("computeType")
                 .dockerServer(DockerServerProperty.builder()
                         .computeType("computeType")
                         .securityGroupIds(List.of("securityGroupIds"))
                         .build())
                 .environmentVariables(List.of(EnvironmentVariableProperty.builder()
                         .name("name")
                         .type("type")
                         .value("value")
                         .build()))
                 .fleet(ProjectFleetProperty.builder()
                         .fleetArn("fleetArn")
                         .build())
                 .image("image")
                 .imagePullCredentialsType("imagePullCredentialsType")
                 .privilegedMode(false)
                 .registryCredential(RegistryCredentialProperty.builder()
                         .credential("credential")
                         .credentialProvider("credentialProvider")
                         .build())
                 .type("type")
                 .build())
         .fileSystemLocations(List.of(ProjectFileSystemLocationProperty.builder()
                 .identifier("identifier")
                 .location("location")
                 .mountOptions("mountOptions")
                 .mountPoint("mountPoint")
                 .type("type")
                 .build()))
         .logsConfig(LogsConfigProperty.builder()
                 .cloudWatchLogs(CloudWatchLogsConfigProperty.builder()
                         .groupName("groupName")
                         .status("status")
                         .streamName("streamName")
                         .build())
                 .s3Logs(S3LogsConfigProperty.builder()
                         .encryptionDisabled(false)
                         .location("location")
                         .status("status")
                         .build())
                 .build())
         .name("name")
         .queuedTimeoutInMinutes(123)
         .resourceAccessRole("resourceAccessRole")
         .secondaryArtifacts(List.of(ArtifactsProperty.builder()
                 .artifactIdentifier("artifactIdentifier")
                 .encryptionDisabled(false)
                 .location("location")
                 .name("name")
                 .namespaceType("namespaceType")
                 .overrideArtifactName(false)
                 .packaging("packaging")
                 .path("path")
                 .type("type")
                 .build()))
         .secondarySources(List.of(SourceProperty.builder()
                 .auth(SourceAuthProperty.builder()
                         .resource("resource")
                         .type("type")
                         .build())
                 .buildSpec("buildSpec")
                 .buildStatusConfig(BuildStatusConfigProperty.builder()
                         .context("context")
                         .targetUrl("targetUrl")
                         .build())
                 .gitCloneDepth(123)
                 .gitSubmodulesConfig(GitSubmodulesConfigProperty.builder()
                         .fetchSubmodules(false)
                         .build())
                 .insecureSsl(false)
                 .location("location")
                 .reportBuildStatus(false)
                 .sourceIdentifier("sourceIdentifier")
                 .type("type")
                 .build()))
         .secondarySourceVersions(List.of(ProjectSourceVersionProperty.builder()
                 .sourceIdentifier("sourceIdentifier")
                 .sourceVersion("sourceVersion")
                 .build()))
         .serviceRole("serviceRole")
         .source(SourceProperty.builder()
                 .auth(SourceAuthProperty.builder()
                         .resource("resource")
                         .type("type")
                         .build())
                 .buildSpec("buildSpec")
                 .buildStatusConfig(BuildStatusConfigProperty.builder()
                         .context("context")
                         .targetUrl("targetUrl")
                         .build())
                 .gitCloneDepth(123)
                 .gitSubmodulesConfig(GitSubmodulesConfigProperty.builder()
                         .fetchSubmodules(false)
                         .build())
                 .insecureSsl(false)
                 .location("location")
                 .reportBuildStatus(false)
                 .sourceIdentifier("sourceIdentifier")
                 .type("type")
                 .build())
         .sourceVersion("sourceVersion")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .timeoutInMinutes(123)
         .triggers(ProjectTriggersProperty.builder()
                 .buildType("buildType")
                 .filterGroups(List.of(List.of(WebhookFilterProperty.builder()
                         .excludeMatchedPattern(false)
                         .pattern("pattern")
                         .type("type")
                         .build())))
                 .pullRequestBuildPolicy(PullRequestBuildPolicyProperty.builder()
                         .approverRoles(List.of("approverRoles"))
                         .requiresCommentApproval("requiresCommentApproval")
                         .build())
                 .scopeConfiguration(ScopeConfigurationProperty.builder()
                         .domain("domain")
                         .name("name")
                         .scope("scope")
                         .build())
                 .webhook(false)
                 .build())
         .visibility("visibility")
         .vpcConfig(VpcConfigProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnets(List.of("subnets"))
                 .vpcId("vpcId")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnProjectMixinProps.Builder	A builder for CfnProjectMixinProps
static final class	CfnProjectMixinProps.Jsii$Proxy	An implementation for CfnProjectMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnProjectMixinProps.Builder	builder()
default Object	getArtifacts()	Artifacts is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build.
default Number	getAutoRetryLimit()
default Object	getBadgeEnabled()	Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.
default Object	getBuildBatchConfig()	A ProjectBuildBatchConfig object that defines the batch build options for the project.
default Object	getCache()	Settings that AWS CodeBuild uses to store and reuse build dependencies.
default Number	getConcurrentBuildLimit()	The maximum number of concurrent builds that are allowed for this project.
default String	getDescription()	A description that makes the build project easy to identify.
default String	getEncryptionKey()	The AWS Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
default Object	getEnvironment()	The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.
default Object	getFileSystemLocations()	An array of ProjectFileSystemLocation objects for a CodeBuild build project.
default Object	getLogsConfig()	Information about logs for the build project.
default String	getName()	The name of the build project.
default Number	getQueuedTimeoutInMinutes()	The number of minutes a build is allowed to be queued before it times out.
default String	getResourceAccessRole()	The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.
default Object	getSecondaryArtifacts()	A list of Artifacts objects.
default Object	getSecondarySources()	An array of ProjectSource objects.
default Object	getSecondarySourceVersions()	An array of ProjectSourceVersion objects.
default String	getServiceRole()	The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
default Object	getSource()	The source code settings for the project, such as the source code's repository type and location.
default String	getSourceVersion()	A version of the build input to be built for this project.
default List<CfnTag>	getTags()	An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.
default Number	getTimeoutInMinutes()	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.
default Object	getTriggers()	For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.
default String	getVisibility()	Specifies the visibility of the project's builds.
default Object	getVpcConfig()	VpcConfig specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getArtifacts

@Stability(Stable)
@Nullable
default Object getArtifacts()

Artifacts is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build.

Returns union: either IResolvable or CfnProjectPropsMixin.ArtifactsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-artifacts

getAutoRetryLimit

@Stability(Stable)
@Nullable
default Number getAutoRetryLimit()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-autoretrylimit

getBadgeEnabled

@Stability(Stable)
@Nullable
default Object getBadgeEnabled()

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 .

Including build badges with your project is currently not supported if the source type is CodePipeline. If you specify CODEPIPELINE for the Source property, do not specify the BadgeEnabled property.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-badgeenabled

getBuildBatchConfig

@Stability(Stable)
@Nullable
default Object getBuildBatchConfig()

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

Returns union: either IResolvable or CfnProjectPropsMixin.ProjectBuildBatchConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-buildbatchconfig

getCache

@Stability(Stable)
@Nullable
default Object getCache()

Settings that AWS CodeBuild uses to store and reuse build dependencies.

Returns union: either IResolvable or CfnProjectPropsMixin.ProjectCacheProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-cache

getConcurrentBuildLimit

@Stability(Stable)
@Nullable
default Number getConcurrentBuildLimit()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-concurrentbuildlimit

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description that makes the build project easy to identify.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-description

getEncryptionKey

@Stability(Stable)
@Nullable
default String getEncryptionKey()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-encryptionkey

getEnvironment

@Stability(Stable)
@Nullable
default Object getEnvironment()

The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.

Returns union: either IResolvable or CfnProjectPropsMixin.EnvironmentProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-environment

getFileSystemLocations

@Stability(Stable)
@Nullable
default Object getFileSystemLocations()

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnProjectPropsMixin.ProjectFileSystemLocationProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-filesystemlocations

getLogsConfig

@Stability(Stable)
@Nullable
default Object getLogsConfig()

Information about logs for the build project.

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

Returns union: either IResolvable or CfnProjectPropsMixin.LogsConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-logsconfig

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the build project.

The name must be unique across all of the projects in your AWS account .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-name

getQueuedTimeoutInMinutes

@Stability(Stable)
@Nullable
default Number getQueuedTimeoutInMinutes()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-queuedtimeoutinminutes

getResourceAccessRole

@Stability(Stable)
@Nullable
default String getResourceAccessRole()

The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-resourceaccessrole

getSecondaryArtifacts

@Stability(Stable)
@Nullable
default Object getSecondaryArtifacts()

A list of Artifacts objects.

Each artifacts object specifies output settings that the project generates during a build.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnProjectPropsMixin.ArtifactsProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-secondaryartifacts

getSecondarySources

@Stability(Stable)
@Nullable
default Object getSecondarySources()

An array of ProjectSource objects.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnProjectPropsMixin.SourceProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-secondarysources

getSecondarySourceVersions

@Stability(Stable)
@Nullable
default Object getSecondarySourceVersions()

An array of ProjectSourceVersion objects.

If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnProjectPropsMixin.ProjectSourceVersionProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-secondarysourceversions

getServiceRole

@Stability(Stable)
@Nullable
default String getServiceRole()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-servicerole

getSource

@Stability(Stable)
@Nullable
default Object getSource()

The source code settings for the project, such as the source code's repository type and location.

Returns union: either IResolvable or CfnProjectPropsMixin.SourceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-source

getSourceVersion

@Stability(Stable)
@Nullable
default String getSourceVersion()

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 AWS CodeBuild User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-sourceversion

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-tags

getTimeoutInMinutes

@Stability(Stable)
@Nullable
default Number getTimeoutInMinutes()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-timeoutinminutes

getTriggers

@Stability(Stable)
@Nullable
default Object getTriggers()

For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.

Returns union: either IResolvable or CfnProjectPropsMixin.ProjectTriggersProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-triggers

getVisibility

@Stability(Stable)
@Nullable
default String getVisibility()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-visibility

getVpcConfig

@Stability(Stable)
@Nullable
default Object getVpcConfig()

VpcConfig specifies 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 .

Returns union: either IResolvable or CfnProjectPropsMixin.VpcConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-vpcconfig

builder

@Stability(Stable)
static CfnProjectMixinProps.Builder builder()

Returns:

a CfnProjectMixinProps.Builder of CfnProjectMixinProps