Package software.amazon.awscdk.services.codebuild

Class CfnProject

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.codebuild.CfnProject

All Implemented Interfaces:

IInspectable, ITaggable, IProjectRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:34.725Z")
@Stability(Stable)
public class CfnProject
extends CfnResource
implements IInspectable, IProjectRef, ITaggable

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.services.codebuild.*;
 CfnProject cfnProject = CfnProject.Builder.create(this, "MyCfnProject")
         .artifacts(ArtifactsProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .artifactIdentifier("artifactIdentifier")
                 .encryptionDisabled(false)
                 .location("location")
                 .name("name")
                 .namespaceType("namespaceType")
                 .overrideArtifactName(false)
                 .packaging("packaging")
                 .path("path")
                 .build())
         .environment(EnvironmentProperty.builder()
                 .computeType("computeType")
                 .image("image")
                 .type("type")
                 // the properties below are optional
                 .certificate("certificate")
                 .dockerServer(DockerServerProperty.builder()
                         .computeType("computeType")
                         // the properties below are optional
                         .securityGroupIds(List.of("securityGroupIds"))
                         .build())
                 .environmentVariables(List.of(EnvironmentVariableProperty.builder()
                         .name("name")
                         .value("value")
                         // the properties below are optional
                         .type("type")
                         .build()))
                 .fleet(ProjectFleetProperty.builder()
                         .fleetArn("fleetArn")
                         .build())
                 .imagePullCredentialsType("imagePullCredentialsType")
                 .privilegedMode(false)
                 .registryCredential(RegistryCredentialProperty.builder()
                         .credential("credential")
                         .credentialProvider("credentialProvider")
                         .build())
                 .build())
         .serviceRole("serviceRole")
         .source(SourceProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .auth(SourceAuthProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .resource("resource")
                         .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")
                 .build())
         // the properties below are optional
         .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()
                 .type("type")
                 // the properties below are optional
                 .cacheNamespace("cacheNamespace")
                 .location("location")
                 .modes(List.of("modes"))
                 .build())
         .concurrentBuildLimit(123)
         .description("description")
         .encryptionKey("encryptionKey")
         .fileSystemLocations(List.of(ProjectFileSystemLocationProperty.builder()
                 .identifier("identifier")
                 .location("location")
                 .mountPoint("mountPoint")
                 .type("type")
                 // the properties below are optional
                 .mountOptions("mountOptions")
                 .build()))
         .logsConfig(LogsConfigProperty.builder()
                 .cloudWatchLogs(CloudWatchLogsConfigProperty.builder()
                         .status("status")
                         // the properties below are optional
                         .groupName("groupName")
                         .streamName("streamName")
                         .build())
                 .s3Logs(S3LogsConfigProperty.builder()
                         .status("status")
                         // the properties below are optional
                         .encryptionDisabled(false)
                         .location("location")
                         .build())
                 .build())
         .name("name")
         .queuedTimeoutInMinutes(123)
         .resourceAccessRole("resourceAccessRole")
         .secondaryArtifacts(List.of(ArtifactsProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .artifactIdentifier("artifactIdentifier")
                 .encryptionDisabled(false)
                 .location("location")
                 .name("name")
                 .namespaceType("namespaceType")
                 .overrideArtifactName(false)
                 .packaging("packaging")
                 .path("path")
                 .build()))
         .secondarySources(List.of(SourceProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .auth(SourceAuthProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .resource("resource")
                         .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")
                 .build()))
         .secondarySourceVersions(List.of(ProjectSourceVersionProperty.builder()
                 .sourceIdentifier("sourceIdentifier")
                 // the properties below are optional
                 .sourceVersion("sourceVersion")
                 .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()
                         .pattern("pattern")
                         .type("type")
                         // the properties below are optional
                         .excludeMatchedPattern(false)
                         .build())))
                 .pullRequestBuildPolicy(PullRequestBuildPolicyProperty.builder()
                         .requiresCommentApproval("requiresCommentApproval")
                         // the properties below are optional
                         .approverRoles(List.of("approverRoles"))
                         .build())
                 .scopeConfiguration(ScopeConfigurationProperty.builder()
                         .name("name")
                         // the properties below are optional
                         .domain("domain")
                         .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	Class	Description
static interface	CfnProject.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	CfnProject.BatchRestrictionsProperty	Specifies restrictions for the batch build.
static final class	CfnProject.Builder	A fluent builder for CfnProject.
static interface	CfnProject.BuildStatusConfigProperty	Contains information that defines how the AWS CodeBuild build project reports the build status to the source provider.
static interface	CfnProject.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	CfnProject.DockerServerProperty	Example:
static interface	CfnProject.EnvironmentProperty	Environment is a property of the AWS::CodeBuild::Project resource that specifies the environment for an AWS CodeBuild project.
static interface	CfnProject.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	CfnProject.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	CfnProject.LogsConfigProperty	LogsConfig is a property of the AWS CodeBuild Project resource that specifies information about logs for a build project.
static interface	CfnProject.ProjectBuildBatchConfigProperty	Contains configuration information about a batch build project.
static interface	CfnProject.ProjectCacheProperty	ProjectCache is a property of the AWS CodeBuild Project resource that specifies information about the cache for the build project.
static interface	CfnProject.ProjectFileSystemLocationProperty	Information about a file system created by Amazon Elastic File System (EFS).
static interface	CfnProject.ProjectFleetProperty	Information about the compute fleet of the build project.
static interface	CfnProject.ProjectSourceVersionProperty	A source identifier and its corresponding version.
static interface	CfnProject.ProjectTriggersProperty	ProjectTriggers is a property of the AWS CodeBuild Project resource that specifies webhooks that trigger an AWS CodeBuild build.
static interface	CfnProject.PullRequestBuildPolicyProperty	Example:
static interface	CfnProject.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	CfnProject.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	CfnProject.ScopeConfigurationProperty	Contains configuration information about the scope for a webhook.
static interface	CfnProject.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	CfnProject.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	CfnProject.VpcConfigProperty	VpcConfig is a property of the AWS::CodeBuild::Project resource that enable AWS CodeBuild to access resources in an Amazon VPC.
static interface	CfnProject.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.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codebuild.IProjectRef

IProjectRef.Jsii$Default, IProjectRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnProject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnProject(software.amazon.jsii.JsiiObjectRef objRef)
	CfnProject(software.constructs.Construct scope, String id, CfnProjectProps props)

Method Summary

Modifier and Type	Method	Description
Object	getArtifacts()	Artifacts is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build.
String	getAttrArn()	The ARN of the AWS CodeBuild project, such as arn:aws:codebuild:us-west-2:123456789012:project/myProjectName .
String	getAttrId()
Number	getAutoRetryLimit()
Object	getBadgeEnabled()	Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.
Object	getBuildBatchConfig()	A ProjectBuildBatchConfig object that defines the batch build options for the project.
Object	getCache()	Settings that AWS CodeBuild uses to store and reuse build dependencies.
protected Map<String,Object>	getCfnProperties()
Number	getConcurrentBuildLimit()	The maximum number of concurrent builds that are allowed for this project.
String	getDescription()	A description that makes the build project easy to identify.
String	getEncryptionKey()	The AWS Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
Object	getEnvironment()	The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.
Object	getFileSystemLocations()	An array of ProjectFileSystemLocation objects for a CodeBuild build project.
Object	getLogsConfig()	Information about logs for the build project.
String	getName()	The name of the build project.
ProjectReference	getProjectRef()	A reference to a Project resource.
Number	getQueuedTimeoutInMinutes()	The number of minutes a build is allowed to be queued before it times out.
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.
Object	getSecondaryArtifacts()	A list of Artifacts objects.
Object	getSecondarySources()	An array of ProjectSource objects.
Object	getSecondarySourceVersions()	An array of ProjectSourceVersion objects.
String	getServiceRole()	The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
Object	getSource()	The source code settings for the project, such as the source code's repository type and location.
String	getSourceVersion()	A version of the build input to be built for this project.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.
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.
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.
String	getVisibility()	Specifies the visibility of the project's builds.
Object	getVpcConfig()	VpcConfig specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setArtifacts(IResolvable value)	Artifacts is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build.
void	setArtifacts(CfnProject.ArtifactsProperty value)	Artifacts is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build.
void	setAutoRetryLimit(Number value)
void	setBadgeEnabled(Boolean value)	Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.
void	setBadgeEnabled(IResolvable value)	Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.
void	setBuildBatchConfig(IResolvable value)	A ProjectBuildBatchConfig object that defines the batch build options for the project.
void	setBuildBatchConfig(CfnProject.ProjectBuildBatchConfigProperty value)	A ProjectBuildBatchConfig object that defines the batch build options for the project.
void	setCache(IResolvable value)	Settings that AWS CodeBuild uses to store and reuse build dependencies.
void	setCache(CfnProject.ProjectCacheProperty value)	Settings that AWS CodeBuild uses to store and reuse build dependencies.
void	setConcurrentBuildLimit(Number value)	The maximum number of concurrent builds that are allowed for this project.
void	setDescription(String value)	A description that makes the build project easy to identify.
void	setEncryptionKey(String value)	The AWS Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
void	setEnvironment(IResolvable value)	The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.
void	setEnvironment(CfnProject.EnvironmentProperty value)	The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.
void	setFileSystemLocations(List<Object> value)	An array of ProjectFileSystemLocation objects for a CodeBuild build project.
void	setFileSystemLocations(IResolvable value)	An array of ProjectFileSystemLocation objects for a CodeBuild build project.
void	setLogsConfig(IResolvable value)	Information about logs for the build project.
void	setLogsConfig(CfnProject.LogsConfigProperty value)	Information about logs for the build project.
void	setName(String value)	The name of the build project.
void	setQueuedTimeoutInMinutes(Number value)	The number of minutes a build is allowed to be queued before it times out.
void	setResourceAccessRole(String value)	The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.
void	setSecondaryArtifacts(List<Object> value)	A list of Artifacts objects.
void	setSecondaryArtifacts(IResolvable value)	A list of Artifacts objects.
void	setSecondarySources(List<Object> value)	An array of ProjectSource objects.
void	setSecondarySources(IResolvable value)	An array of ProjectSource objects.
void	setSecondarySourceVersions(List<Object> value)	An array of ProjectSourceVersion objects.
void	setSecondarySourceVersions(IResolvable value)	An array of ProjectSourceVersion objects.
void	setServiceRole(String value)	The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
void	setSource(IResolvable value)	The source code settings for the project, such as the source code's repository type and location.
void	setSource(CfnProject.SourceProperty value)	The source code settings for the project, such as the source code's repository type and location.
void	setSourceVersion(String value)	A version of the build input to be built for this project.
void	setTagsRaw(List<CfnTag> value)	An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.
void	setTimeoutInMinutes(Number value)	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.
void	setTriggers(IResolvable value)	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.
void	setTriggers(CfnProject.ProjectTriggersProperty value)	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.
void	setVisibility(String value)	Specifies the visibility of the project's builds.
void	setVpcConfig(IResolvable value)	VpcConfig specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC.
void	setVpcConfig(CfnProject.VpcConfigProperty value)	VpcConfig specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnProject

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

CfnProject

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

CfnProject

@Stability(Stable)
public CfnProject(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnProjectProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The ARN of the AWS CodeBuild project, such as arn:aws:codebuild:us-west-2:123456789012:project/myProjectName .

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getProjectRef

@Stability(Stable)
@NotNull
public ProjectReference getProjectRef()

A reference to a Project resource.

Specified by:

getProjectRef in interface IProjectRef

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getArtifacts

@Stability(Stable)
@NotNull
public 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 CfnProject.ArtifactsProperty

setArtifacts

@Stability(Stable)
public void setArtifacts(@NotNull
 IResolvable value)

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

setArtifacts

@Stability(Stable)
public void setArtifacts(@NotNull
 CfnProject.ArtifactsProperty value)

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

getEnvironment

@Stability(Stable)
@NotNull
public 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 CfnProject.EnvironmentProperty

setEnvironment

@Stability(Stable)
public void setEnvironment(@NotNull
 IResolvable value)

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

setEnvironment

@Stability(Stable)
public void setEnvironment(@NotNull
 CfnProject.EnvironmentProperty value)

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

getServiceRole

@Stability(Stable)
@NotNull
public String getServiceRole()

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

setServiceRole

@Stability(Stable)
public void setServiceRole(@NotNull
 String value)

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

getSource

@Stability(Stable)
@NotNull
public Object getSource()

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

Returns union: either IResolvable or CfnProject.SourceProperty

setSource

@Stability(Stable)
public void setSource(@NotNull
 IResolvable value)

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

setSource

@Stability(Stable)
public void setSource(@NotNull
 CfnProject.SourceProperty value)

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

getAutoRetryLimit

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

setAutoRetryLimit

@Stability(Stable)
public void setAutoRetryLimit(@Nullable
 Number value)

getBadgeEnabled

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

Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.

Returns union: either Boolean or IResolvable

setBadgeEnabled

@Stability(Stable)
public void setBadgeEnabled(@Nullable
 Boolean value)

Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.

setBadgeEnabled

@Stability(Stable)
public void setBadgeEnabled(@Nullable
 IResolvable value)

Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.

getBuildBatchConfig

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

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

Returns union: either IResolvable or CfnProject.ProjectBuildBatchConfigProperty

setBuildBatchConfig

@Stability(Stable)
public void setBuildBatchConfig(@Nullable
 IResolvable value)

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

setBuildBatchConfig

@Stability(Stable)
public void setBuildBatchConfig(@Nullable
 CfnProject.ProjectBuildBatchConfigProperty value)

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

getCache

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

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

Returns union: either IResolvable or CfnProject.ProjectCacheProperty

setCache

@Stability(Stable)
public void setCache(@Nullable
 IResolvable value)

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

setCache

@Stability(Stable)
public void setCache(@Nullable
 CfnProject.ProjectCacheProperty value)

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

getConcurrentBuildLimit

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

The maximum number of concurrent builds that are allowed for this project.

setConcurrentBuildLimit

@Stability(Stable)
public void setConcurrentBuildLimit(@Nullable
 Number value)

The maximum number of concurrent builds that are allowed for this project.

getDescription

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

A description that makes the build project easy to identify.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

A description that makes the build project easy to identify.

getEncryptionKey

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

The AWS Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

setEncryptionKey

@Stability(Stable)
public void setEncryptionKey(@Nullable
 String value)

The AWS Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

getFileSystemLocations

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

An array of ProjectFileSystemLocation objects for a CodeBuild build project.

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

setFileSystemLocations

@Stability(Stable)
public void setFileSystemLocations(@Nullable
 IResolvable value)

An array of ProjectFileSystemLocation objects for a CodeBuild build project.

setFileSystemLocations

@Stability(Stable)
public void setFileSystemLocations(@Nullable
 List<Object> value)

An array of ProjectFileSystemLocation objects for a CodeBuild build project.

getLogsConfig

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

Information about logs for the build project.

Returns union: either IResolvable or CfnProject.LogsConfigProperty

setLogsConfig

@Stability(Stable)
public void setLogsConfig(@Nullable
 IResolvable value)

Information about logs for the build project.

setLogsConfig

@Stability(Stable)
public void setLogsConfig(@Nullable
 CfnProject.LogsConfigProperty value)

Information about logs for the build project.

getName

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

The name of the build project.

setName

@Stability(Stable)
public void setName(@Nullable
 String value)

The name of the build project.

getQueuedTimeoutInMinutes

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

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

setQueuedTimeoutInMinutes

@Stability(Stable)
public void setQueuedTimeoutInMinutes(@Nullable
 Number value)

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

getResourceAccessRole

@Stability(Stable)
@Nullable
public 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.

setResourceAccessRole

@Stability(Stable)
public void setResourceAccessRole(@Nullable
 String value)

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

getSecondaryArtifacts

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

A list of Artifacts objects.

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

setSecondaryArtifacts

@Stability(Stable)
public void setSecondaryArtifacts(@Nullable
 IResolvable value)

A list of Artifacts objects.

setSecondaryArtifacts

@Stability(Stable)
public void setSecondaryArtifacts(@Nullable
 List<Object> value)

A list of Artifacts objects.

getSecondarySources

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

An array of ProjectSource objects.

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

setSecondarySources

@Stability(Stable)
public void setSecondarySources(@Nullable
 IResolvable value)

An array of ProjectSource objects.

setSecondarySources

@Stability(Stable)
public void setSecondarySources(@Nullable
 List<Object> value)

An array of ProjectSource objects.

getSecondarySourceVersions

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

An array of ProjectSourceVersion objects.

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

setSecondarySourceVersions

@Stability(Stable)
public void setSecondarySourceVersions(@Nullable
 IResolvable value)

An array of ProjectSourceVersion objects.

setSecondarySourceVersions

@Stability(Stable)
public void setSecondarySourceVersions(@Nullable
 List<Object> value)

An array of ProjectSourceVersion objects.

getSourceVersion

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

A version of the build input to be built for this project.

setSourceVersion

@Stability(Stable)
public void setSourceVersion(@Nullable
 String value)

A version of the build input to be built for this project.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.

getTimeoutInMinutes

@Stability(Stable)
@Nullable
public 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.

setTimeoutInMinutes

@Stability(Stable)
public void setTimeoutInMinutes(@Nullable
 Number value)

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.

getTriggers

@Stability(Stable)
@Nullable
public 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 CfnProject.ProjectTriggersProperty

setTriggers

@Stability(Stable)
public void setTriggers(@Nullable
 IResolvable value)

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.

setTriggers

@Stability(Stable)
public void setTriggers(@Nullable
 CfnProject.ProjectTriggersProperty value)

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.

getVisibility

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

Specifies the visibility of the project's builds.

Possible values are:.

setVisibility

@Stability(Stable)
public void setVisibility(@Nullable
 String value)

Specifies the visibility of the project's builds.

Possible values are:.

getVpcConfig

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

VpcConfig specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC.

Returns union: either IResolvable or CfnProject.VpcConfigProperty

setVpcConfig

@Stability(Stable)
public void setVpcConfig(@Nullable
 IResolvable value)

VpcConfig specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC.

setVpcConfig

@Stability(Stable)
public void setVpcConfig(@Nullable
 CfnProject.VpcConfigProperty value)

VpcConfig specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC.