Package software.amazon.awscdk.services.codebuild

Interface CfnProjectProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnProjectProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:00.973Z") @Stability(Stable) public interface CfnProjectProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnProject.

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.*;
 CfnProjectProps cfnProjectProps = CfnProjectProps.builder()
         .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:

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static CfnProjectProps.Builder
    builder()
     
    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.
    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.
    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.
    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