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

Class CfnProjectPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.codebuild.CfnProjectPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:57.236Z")
@Stability(Stable)
public class CfnProjectPropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::CodeBuild::Project resource configures how AWS CodeBuild builds your source code.

For example, it tells CodeBuild where to get the source code and which build environment to use.

To unset or remove a project value via CFN, explicitly provide the attribute with value as empty input.

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.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnProjectPropsMixin cfnProjectPropsMixin = CfnProjectPropsMixin.Builder.create(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())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnProjectPropsMixin.ArtifactsProperty	Artifacts is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build.
static interface	CfnProjectPropsMixin.BatchRestrictionsProperty	Specifies restrictions for the batch build.
static final class	CfnProjectPropsMixin.Builder	A fluent builder for CfnProjectPropsMixin.
static interface	CfnProjectPropsMixin.BuildStatusConfigProperty	Contains information that defines how the AWS CodeBuild build project reports the build status to the source provider.
static interface	CfnProjectPropsMixin.CloudWatchLogsConfigProperty	CloudWatchLogs is a property of the AWS CodeBuild Project LogsConfig property type that specifies settings for CloudWatch logs generated by an AWS CodeBuild build.
static interface	CfnProjectPropsMixin.DockerServerProperty	Example:
static interface	CfnProjectPropsMixin.EnvironmentProperty	Environment is a property of the AWS::CodeBuild::Project resource that specifies the environment for an AWS CodeBuild project.
static interface	CfnProjectPropsMixin.EnvironmentVariableProperty	EnvironmentVariable is a property of the AWS CodeBuild Project Environment property type that specifies the name and value of an environment variable for an AWS CodeBuild project environment.
static interface	CfnProjectPropsMixin.GitSubmodulesConfigProperty	GitSubmodulesConfig is a property of the AWS CodeBuild Project Source property type that specifies information about the Git submodules configuration for the build project.
static interface	CfnProjectPropsMixin.LogsConfigProperty	LogsConfig is a property of the AWS CodeBuild Project resource that specifies information about logs for a build project.
static interface	CfnProjectPropsMixin.ProjectBuildBatchConfigProperty	Contains configuration information about a batch build project.
static interface	CfnProjectPropsMixin.ProjectCacheProperty	ProjectCache is a property of the AWS CodeBuild Project resource that specifies information about the cache for the build project.
static interface	CfnProjectPropsMixin.ProjectFileSystemLocationProperty	Information about a file system created by Amazon Elastic File System (EFS).
static interface	CfnProjectPropsMixin.ProjectFleetProperty	Information about the compute fleet of the build project.
static interface	CfnProjectPropsMixin.ProjectSourceVersionProperty	A source identifier and its corresponding version.
static interface	CfnProjectPropsMixin.ProjectTriggersProperty	ProjectTriggers is a property of the AWS CodeBuild Project resource that specifies webhooks that trigger an AWS CodeBuild build.
static interface	CfnProjectPropsMixin.PullRequestBuildPolicyProperty	Example:
static interface	CfnProjectPropsMixin.RegistryCredentialProperty	RegistryCredential is a property of the AWS CodeBuild Project Environment property type that specifies information about credentials that provide access to a private Docker registry.
static interface	CfnProjectPropsMixin.S3LogsConfigProperty	S3Logs is a property of the AWS CodeBuild Project LogsConfig property type that specifies settings for logs generated by an AWS CodeBuild build in an S3 bucket.
static interface	CfnProjectPropsMixin.ScopeConfigurationProperty	Contains configuration information about the scope for a webhook.
static interface	CfnProjectPropsMixin.SourceAuthProperty	SourceAuth is a property of the AWS CodeBuild Project Source property type that specifies authorization settings for AWS CodeBuild to access the source code to be built.
static interface	CfnProjectPropsMixin.SourceProperty	Source is a property of the AWS::CodeBuild::Project resource that specifies the source code settings for the project, such as the source code's repository type and location.
static interface	CfnProjectPropsMixin.VpcConfigProperty	VpcConfig is a property of the AWS::CodeBuild::Project resource that enable AWS CodeBuild to access resources in an Amazon VPC.
static interface	CfnProjectPropsMixin.WebhookFilterProperty	WebhookFilter is a structure of the FilterGroups property on the AWS CodeBuild Project ProjectTriggers property type that specifies which webhooks trigger an AWS CodeBuild build.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnProjectPropsMixin(CfnProjectMixinProps props)	Create a mixin to apply properties to AWS::CodeBuild::Project.
	CfnProjectPropsMixin(CfnProjectMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::CodeBuild::Project.
protected	CfnProjectPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnProjectPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnProjectMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnProjectPropsMixin

protected CfnProjectPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnProjectPropsMixin

protected CfnProjectPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnProjectPropsMixin

@Stability(Stable)
public CfnProjectPropsMixin(@NotNull
 CfnProjectMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::CodeBuild::Project.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnProjectPropsMixin

@Stability(Stable)
public CfnProjectPropsMixin(@NotNull
 CfnProjectMixinProps props)

Create a mixin to apply properties to AWS::CodeBuild::Project.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnProjectMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()