CfnProject

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.codebuild.CfnProject

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:30.585Z")
public class CfnProject
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CodeBuild::Project`.

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.

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")
                 .environmentVariables(List.of(EnvironmentVariableProperty.builder()
                         .name("name")
                         .value("value")
                         // the properties below are optional
                         .type("type")
                         .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
         .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
                 .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())))
                 .webhook(false)
                 .build())
         .visibility("visibility")
         .vpcConfig(VpcConfigProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnets(List.of("subnets"))
                 .vpcId("vpcId")
                 .build())
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CfnProject.ArtifactsProperty` `Artifacts` is a property of the [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies output settings for artifacts generated by an AWS CodeBuild build.
`static interface`	`CfnProject.BatchRestrictionsProperty` Specifies restrictions for the batch build.
`static 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html) property type that specifies settings for CloudWatch logs generated by an AWS CodeBuild build.
`static interface`	`CfnProject.EnvironmentProperty` `Environment` is a property of the [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies the environment for an AWS CodeBuild project.
`static interface`	`CfnProject.EnvironmentVariableProperty` `EnvironmentVariable` is a property of the [AWS CodeBuild Project Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html) 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html) 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) 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.ProjectSourceVersionProperty` A source identifier and its corresponding version.
`static interface`	`CfnProject.ProjectTriggersProperty` `ProjectTriggers` is a property of the [AWS CodeBuild Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies webhooks that trigger an AWS CodeBuild build.
`static interface`	`CfnProject.RegistryCredentialProperty` `RegistryCredential` is a property of the [AWS CodeBuild Project Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html) 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html) property type that specifies settings for logs generated by an AWS CodeBuild build in an S3 bucket.
`static interface`	`CfnProject.SourceAuthProperty` `SourceAuth` is a property of the [AWS CodeBuild Project Source](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html) 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html) property type that specifies which webhooks trigger an AWS CodeBuild build.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnProject(Construct scope, java.lang.String id, CfnProjectProps props)` Create a new `AWS::CodeBuild::Project`.
`protected`	`CfnProject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnProject(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`getArtifacts()` `Artifacts` is a property of the [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies output settings for artifacts generated by an AWS CodeBuild build.
`java.lang.String`	`getAttrArn()` The ARN of the AWS CodeBuild project, such as `arn:aws:codebuild:us-west-2:123456789012:project/myProjectName` .
`java.lang.Object`	`getBadgeEnabled()` Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.
`java.lang.Object`	`getBuildBatchConfig()` A `ProjectBuildBatchConfig` object that defines the batch build options for the project.
`java.lang.Object`	`getCache()` Settings that AWS CodeBuild uses to store and reuse build dependencies.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.Number`	`getConcurrentBuildLimit()` The maximum number of concurrent builds that are allowed for this project.
`java.lang.String`	`getDescription()` A description that makes the build project easy to identify.
`java.lang.String`	`getEncryptionKey()` The AWS Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
`java.lang.Object`	`getEnvironment()` The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.
`java.lang.Object`	`getFileSystemLocations()` An array of `ProjectFileSystemLocation` objects for a CodeBuild build project.
`java.lang.Object`	`getLogsConfig()` Information about logs for the build project.
`java.lang.String`	`getName()` The name of the build project.
`java.lang.Number`	`getQueuedTimeoutInMinutes()` The number of minutes a build is allowed to be queued before it times out.
`java.lang.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.
`java.lang.Object`	`getSecondaryArtifacts()` A list of `Artifacts` objects.
`java.lang.Object`	`getSecondarySources()` An array of `ProjectSource` objects.
`java.lang.Object`	`getSecondarySourceVersions()` An array of `ProjectSourceVersion` objects.
`java.lang.String`	`getServiceRole()` The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
`java.lang.Object`	`getSource()` The source code settings for the project, such as the source code's repository type and location.
`java.lang.String`	`getSourceVersion()` A version of the build input to be built for this project.
`TagManager`	`getTags()` An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.
`java.lang.Number`	`getTimeoutInMinutes()` How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed.
`java.lang.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.
`java.lang.String`	`getVisibility()` Specifies the visibility of the project's builds.
`java.lang.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 java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setArtifacts(CfnProject.ArtifactsProperty value)` `Artifacts` is a property of the [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies output settings for artifacts generated by an AWS CodeBuild build.
`void`	`setArtifacts(IResolvable value)` `Artifacts` is a property of the [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies output settings for artifacts generated by an AWS CodeBuild build.
`void`	`setBadgeEnabled(java.lang.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(CfnProject.ProjectBuildBatchConfigProperty value)` A `ProjectBuildBatchConfig` object that defines the batch build options for the project.
`void`	`setBuildBatchConfig(IResolvable value)` A `ProjectBuildBatchConfig` object that defines the batch build options for the project.
`void`	`setCache(CfnProject.ProjectCacheProperty value)` Settings that AWS CodeBuild uses to store and reuse build dependencies.
`void`	`setCache(IResolvable value)` Settings that AWS CodeBuild uses to store and reuse build dependencies.
`void`	`setConcurrentBuildLimit(java.lang.Number value)` The maximum number of concurrent builds that are allowed for this project.
`void`	`setDescription(java.lang.String value)` A description that makes the build project easy to identify.
`void`	`setEncryptionKey(java.lang.String value)` The AWS Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
`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`	`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`	`setFileSystemLocations(IResolvable value)` An array of `ProjectFileSystemLocation` objects for a CodeBuild build project.
`void`	`setFileSystemLocations(java.util.List<java.lang.Object> value)` An array of `ProjectFileSystemLocation` objects for a CodeBuild build project.
`void`	`setLogsConfig(CfnProject.LogsConfigProperty value)` Information about logs for the build project.
`void`	`setLogsConfig(IResolvable value)` Information about logs for the build project.
`void`	`setName(java.lang.String value)` The name of the build project.
`void`	`setQueuedTimeoutInMinutes(java.lang.Number value)` The number of minutes a build is allowed to be queued before it times out.
`void`	`setResourceAccessRole(java.lang.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(IResolvable value)` A list of `Artifacts` objects.
`void`	`setSecondaryArtifacts(java.util.List<java.lang.Object> value)` A list of `Artifacts` objects.
`void`	`setSecondarySources(IResolvable value)` An array of `ProjectSource` objects.
`void`	`setSecondarySources(java.util.List<java.lang.Object> value)` An array of `ProjectSource` objects.
`void`	`setSecondarySourceVersions(IResolvable value)` An array of `ProjectSourceVersion` objects.
`void`	`setSecondarySourceVersions(java.util.List<java.lang.Object> value)` An array of `ProjectSourceVersion` objects.
`void`	`setServiceRole(java.lang.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(CfnProject.SourceProperty value)` The source code settings for the project, such as the source code's repository type and location.
`void`	`setSource(IResolvable value)` The source code settings for the project, such as the source code's repository type and location.
`void`	`setSourceVersion(java.lang.String value)` A version of the build input to be built for this project.
`void`	`setTimeoutInMinutes(java.lang.Number value)` How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed.
`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`	`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`	`setVisibility(java.lang.String value)` Specifies the visibility of the project's builds.
`void`	`setVpcConfig(CfnProject.VpcConfigProperty value)` `VpcConfig` specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC.
`void`	`setVpcConfig(IResolvable value)` `VpcConfig` specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnProject
```
protected CfnProject(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnProject
```
protected CfnProject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnProject
```
public CfnProject(Construct scope,
                  java.lang.String id,
                  CfnProjectProps props)
```
    Create a new `AWS::CodeBuild::Project`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.String getAttrArn()
```
    The ARN of the AWS CodeBuild project, such as `arn:aws:codebuild:us-west-2:123456789012:project/myProjectName` .
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager 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.
  - getArtifacts
```
public java.lang.Object getArtifacts()
```
    `Artifacts` is a property of the [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies output settings for artifacts generated by an AWS CodeBuild build.
  - setArtifacts
```
public void setArtifacts(IResolvable value)
```
    `Artifacts` is a property of the [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies output settings for artifacts generated by an AWS CodeBuild build.
  - setArtifacts
```
public void setArtifacts(CfnProject.ArtifactsProperty value)
```
    `Artifacts` is a property of the [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies output settings for artifacts generated by an AWS CodeBuild build.
  - getEnvironment
```
public java.lang.Object getEnvironment()
```
    The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.
  - setEnvironment
```
public 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.
  - setEnvironment
```
public 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.
  - getServiceRole
```
public java.lang.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
```
public void setServiceRole(java.lang.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
```
public java.lang.Object getSource()
```
    The source code settings for the project, such as the source code's repository type and location.
  - setSource
```
public void setSource(CfnProject.SourceProperty value)
```
    The source code settings for the project, such as the source code's repository type and location.
  - setSource
```
public void setSource(IResolvable value)
```
    The source code settings for the project, such as the source code's repository type and location.
  - getBadgeEnabled
```
public java.lang.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.
  - setBadgeEnabled
```
public void setBadgeEnabled(java.lang.Boolean value)
```
    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.
  - setBadgeEnabled
```
public void setBadgeEnabled(IResolvable value)
```
    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.
  - getBuildBatchConfig
```
public java.lang.Object getBuildBatchConfig()
```
    A `ProjectBuildBatchConfig` object that defines the batch build options for the project.
  - setBuildBatchConfig
```
public void setBuildBatchConfig(IResolvable value)
```
    A `ProjectBuildBatchConfig` object that defines the batch build options for the project.
  - setBuildBatchConfig
```
public void setBuildBatchConfig(CfnProject.ProjectBuildBatchConfigProperty value)
```
    A `ProjectBuildBatchConfig` object that defines the batch build options for the project.
  - getCache
```
public java.lang.Object getCache()
```
    Settings that AWS CodeBuild uses to store and reuse build dependencies.
  - setCache
```
public void setCache(IResolvable value)
```
    Settings that AWS CodeBuild uses to store and reuse build dependencies.
  - setCache
```
public void setCache(CfnProject.ProjectCacheProperty value)
```
    Settings that AWS CodeBuild uses to store and reuse build dependencies.
  - getConcurrentBuildLimit
```
public java.lang.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.
  - setConcurrentBuildLimit
```
public void setConcurrentBuildLimit(java.lang.Number value)
```
    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.
  - getDescription
```
public java.lang.String getDescription()
```
    A description that makes the build project easy to identify.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    A description that makes the build project easy to identify.
  - getEncryptionKey
```
public java.lang.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).
  - setEncryptionKey
```
public void setEncryptionKey(java.lang.String value)
```
    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).
  - getFileSystemLocations
```
public java.lang.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.
  - setFileSystemLocations
```
public void setFileSystemLocations(IResolvable value)
```
    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.
  - setFileSystemLocations
```
public void setFileSystemLocations(java.util.List<java.lang.Object> value)
```
    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.
  - getLogsConfig
```
public java.lang.Object getLogsConfig()
```
    Information about logs for the build project.
    A project can create logs in CloudWatch Logs, an S3 bucket, or both.
  - setLogsConfig
```
public void setLogsConfig(IResolvable value)
```
    Information about logs for the build project.
    A project can create logs in CloudWatch Logs, an S3 bucket, or both.
  - setLogsConfig
```
public void setLogsConfig(CfnProject.LogsConfigProperty value)
```
    Information about logs for the build project.
    A project can create logs in CloudWatch Logs, an S3 bucket, or both.
  - getName
```
public java.lang.String getName()
```
    The name of the build project.
    The name must be unique across all of the projects in your AWS account .
  - setName
```
public void setName(java.lang.String value)
```
    The name of the build project.
    The name must be unique across all of the projects in your AWS account .
  - getQueuedTimeoutInMinutes
```
public java.lang.Number getQueuedTimeoutInMinutes()
```
    The number of minutes a build is allowed to be queued before it times out.
  - setQueuedTimeoutInMinutes
```
public void setQueuedTimeoutInMinutes(java.lang.Number value)
```
    The number of minutes a build is allowed to be queued before it times out.
  - getResourceAccessRole
```
public java.lang.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
```
public void setResourceAccessRole(java.lang.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
```
public java.lang.Object getSecondaryArtifacts()
```
    A list of `Artifacts` objects.
    Each artifacts object specifies output settings that the project generates during a build.
  - setSecondaryArtifacts
```
public void setSecondaryArtifacts(IResolvable value)
```
    A list of `Artifacts` objects.
    Each artifacts object specifies output settings that the project generates during a build.
  - setSecondaryArtifacts
```
public void setSecondaryArtifacts(java.util.List<java.lang.Object> value)
```
    A list of `Artifacts` objects.
    Each artifacts object specifies output settings that the project generates during a build.
  - getSecondarySources
```
public java.lang.Object getSecondarySources()
```
    An array of `ProjectSource` objects.
  - setSecondarySources
```
public void setSecondarySources(IResolvable value)
```
    An array of `ProjectSource` objects.
  - setSecondarySources
```
public void setSecondarySources(java.util.List<java.lang.Object> value)
```
    An array of `ProjectSource` objects.
  - getSecondarySourceVersions
```
public java.lang.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).
  - setSecondarySourceVersions
```
public void setSecondarySourceVersions(IResolvable value)
```
    An array of `ProjectSourceVersion` objects.
    If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).
  - setSecondarySourceVersions
```
public void setSecondarySourceVersions(java.util.List<java.lang.Object> value)
```
    An array of `ProjectSourceVersion` objects.
    If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).
  - getSourceVersion
```
public java.lang.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 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 .
  - setSourceVersion
```
public void setSourceVersion(java.lang.String value)
```
    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 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 .
  - getTimeoutInMinutes
```
public java.lang.Number getTimeoutInMinutes()
```
    How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed.
    The default is 60 minutes.
  - setTimeoutInMinutes
```
public void setTimeoutInMinutes(java.lang.Number value)
```
    How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed.
    The default is 60 minutes.
  - getTriggers
```
public java.lang.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.
  - setTriggers
```
public 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.
  - setTriggers
```
public 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.
  - getVisibility
```
public java.lang.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.
  - setVisibility
```
public void setVisibility(java.lang.String value)
```
    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.
  - getVpcConfig
```
public java.lang.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 .
  - setVpcConfig
```
public void setVpcConfig(IResolvable value)
```
    `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 .
  - setVpcConfig
```
public void setVpcConfig(CfnProject.VpcConfigProperty value)
```
    `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 .

Class CfnProject

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnProject

CfnProject

CfnProject

Method Detail

inspect

renderProperties

getAttrArn

getCfnProperties

getTags

getArtifacts

setArtifacts

setArtifacts

getEnvironment

setEnvironment

setEnvironment

getServiceRole

setServiceRole

getSource

setSource

setSource

getBadgeEnabled

setBadgeEnabled

setBadgeEnabled

getBuildBatchConfig

setBuildBatchConfig

setBuildBatchConfig

getCache

setCache

setCache

getConcurrentBuildLimit

setConcurrentBuildLimit

getDescription

setDescription

getEncryptionKey

setEncryptionKey

getFileSystemLocations

setFileSystemLocations

setFileSystemLocations

getLogsConfig

setLogsConfig

setLogsConfig

getName

setName

getQueuedTimeoutInMinutes

setQueuedTimeoutInMinutes

getResourceAccessRole

setResourceAccessRole

getSecondaryArtifacts

setSecondaryArtifacts

setSecondaryArtifacts

getSecondarySources

setSecondarySources

setSecondarySources

getSecondarySourceVersions

setSecondarySourceVersions

setSecondarySourceVersions

getSourceVersion

setSourceVersion

getTimeoutInMinutes

setTimeoutInMinutes

getTriggers

setTriggers

setTriggers

getVisibility

setVisibility