Project (software.amazon.awscdk:aws-cdk-lib 2.0.0-rc.10 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Construct
  - - software.amazon.awscdk.Resource
    - - software.amazon.awscdk.services.codebuild.Project

All Implemented Interfaces:

IResource, IProject, IConnectable, IGrantable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

Direct Known Subclasses:

PipelineProject
```
@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:56.549Z")
 @Stability(value=Experimental)
public class Project
extends Resource
implements IProject
```
(experimental) A representation of a CodeBuild Project.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Project.Builder
(experimental) A fluent builder for Project.
- Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
  software.amazon.jsii.JsiiObject.InitializationMode
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codebuild.IProject
  IProject.Jsii$Default, IProject.Jsii$Proxy

Nested Classes
Modifier and Type	Class and Description
`static class`	`Project.Builder` (experimental) A fluent builder for `Project`.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`Project(software.constructs.Construct scope, String id, ProjectProps props)`
`protected`	`Project(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`Project(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFileSystemLocation(IFileSystemLocation fileSystemLocation)` (experimental) Adds a fileSystemLocation to the Project.
`void`	`addSecondaryArtifact(IArtifacts secondaryArtifact)` (experimental) Adds a secondary artifact to the Project.
`void`	`addSecondarySource(ISource secondarySource)` (experimental) Adds a secondary source to the Project.
`void`	`addToRolePolicy(PolicyStatement statement)` (experimental) Add a permission only if there's a policy attached.
`void`	`bindToCodePipeline(software.constructs.Construct _scope, BindToCodePipelineOptions options)` (experimental) A callback invoked when the given project is added to a CodePipeline.
`BatchBuildConfig`	`enableBatchBuilds()` (experimental) Enable batch builds.
`static IProject`	`fromProjectArn(software.constructs.Construct scope, String id, String projectArn)`
`static IProject`	`fromProjectName(software.constructs.Construct scope, String id, String projectName)` (experimental) Import a Project defined either outside the CDK, or in a different CDK Stack (and exported using the `export` method).
`Connections`	`getConnections()` (experimental) Access the Connections object.
`IPrincipal`	`getGrantPrincipal()` (experimental) The principal to grant permissions to.
`String`	`getProjectArn()` (experimental) The ARN of the project.
`String`	`getProjectName()` (experimental) The name of the project.
`IRole`	`getRole()` (experimental) The IAM role for this project.
`Metric`	`metric(String metricName)`
`Metric`	`metric(String metricName, MetricOptions props)`
`Metric`	`metricBuilds()` (experimental) Measures the number of builds triggered.
`Metric`	`metricBuilds(MetricOptions props)` (experimental) Measures the number of builds triggered.
`Metric`	`metricDuration()` (experimental) Measures the duration of all builds over time.
`Metric`	`metricDuration(MetricOptions props)` (experimental) Measures the duration of all builds over time.
`Metric`	`metricFailedBuilds()` (experimental) Measures the number of builds that failed because of client error or because of a timeout.
`Metric`	`metricFailedBuilds(MetricOptions props)` (experimental) Measures the number of builds that failed because of client error or because of a timeout.
`Metric`	`metricSucceededBuilds()` (experimental) Measures the number of successful builds.
`Metric`	`metricSucceededBuilds(MetricOptions props)` (experimental) Measures the number of successful builds.
`Rule`	`onBuildFailed(String id)` (experimental) Defines an event rule which triggers when a build fails.
`Rule`	`onBuildFailed(String id, OnEventOptions options)` (experimental) Defines an event rule which triggers when a build fails.
`Rule`	`onBuildStarted(String id)` (experimental) Defines an event rule which triggers when a build starts.
`Rule`	`onBuildStarted(String id, OnEventOptions options)` (experimental) Defines an event rule which triggers when a build starts.
`Rule`	`onBuildSucceeded(String id)` (experimental) Defines an event rule which triggers when a build completes successfully.
`Rule`	`onBuildSucceeded(String id, OnEventOptions options)` (experimental) Defines an event rule which triggers when a build completes successfully.
`Rule`	`onEvent(String id)` (experimental) Defines a CloudWatch event rule triggered when something happens with this project.
`Rule`	`onEvent(String id, OnEventOptions options)` (experimental) Defines a CloudWatch event rule triggered when something happens with this project.
`Rule`	`onPhaseChange(String id)` (experimental) Defines a CloudWatch event rule that triggers upon phase change of this build project.
`Rule`	`onPhaseChange(String id, OnEventOptions options)` (experimental) Defines a CloudWatch event rule that triggers upon phase change of this build project.
`Rule`	`onStateChange(String id)` (experimental) Defines a CloudWatch event rule triggered when the build project state changes.
`Rule`	`onStateChange(String id, OnEventOptions options)` (experimental) Defines a CloudWatch event rule triggered when the build project state changes.
`static List<CfnProject.EnvironmentVariableProperty>`	`serializeEnvVariables(Map<String,? extends BuildEnvironmentVariable> environmentVariables)` (experimental) Convert the environment variables map of string to `BuildEnvironmentVariable`, which is the customer-facing type, to a list of `CfnProject.EnvironmentVariableProperty`, which is the representation of environment variables in CloudFormation.
`static List<CfnProject.EnvironmentVariableProperty>`	`serializeEnvVariables(Map<String,? extends BuildEnvironmentVariable> environmentVariables, Boolean validateNoPlainTextSecrets)` (experimental) Convert the environment variables map of string to `BuildEnvironmentVariable`, which is the customer-facing type, to a list of `CfnProject.EnvironmentVariableProperty`, which is the representation of environment variables in CloudFormation.
`static List<CfnProject.EnvironmentVariableProperty>`	`serializeEnvVariables(Map<String,? extends BuildEnvironmentVariable> environmentVariables, Boolean validateNoPlainTextSecrets, IGrantable principal)` (experimental) Convert the environment variables map of string to `BuildEnvironmentVariable`, which is the customer-facing type, to a list of `CfnProject.EnvironmentVariableProperty`, which is the representation of environment variables in CloudFormation.

Methods inherited from class software.amazon.awscdk.Resource
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.constructs.Construct
getNode, isConstruct, toString

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.amazon.awscdk.IResource
getEnv, getStack

Methods inherited from interface software.constructs.IConstruct
getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Constructor Detail

Project

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

Project

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

Project

@Stability(value=Experimental)
public Project(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              ProjectProps props)

Parameters:: scope - This parameter is required.; id - This parameter is required.; props - This parameter is required.

Method Detail

fromProjectArn

@Stability(value=Experimental)
 @NotNull
public static IProject fromProjectArn(@NotNull
                                                                               software.constructs.Construct scope,
                                                                               @NotNull
                                                                               String id,
                                                                               @NotNull
                                                                               String projectArn)

Parameters:: scope - This parameter is required.; id - This parameter is required.; projectArn - This parameter is required.

fromProjectName

@Stability(value=Experimental)
 @NotNull
public static IProject fromProjectName(@NotNull
                                                                                software.constructs.Construct scope,
                                                                                @NotNull
                                                                                String id,
                                                                                @NotNull
                                                                                String projectName)

(experimental) Import a Project defined either outside the CDK, or in a different CDK Stack (and exported using the export method).

Parameters:: scope - the parent Construct for this Construct. This parameter is required.; id - the logical name of this Construct. This parameter is required.; projectName - the name of the project to import. This parameter is required.
Returns:: a reference to the existing Project

serializeEnvVariables

@Stability(value=Experimental)
 @NotNull
public static List<CfnProject.EnvironmentVariableProperty> serializeEnvVariables(@NotNull
                                                                                                                          Map<String,? extends BuildEnvironmentVariable> environmentVariables,
                                                                                                                          @Nullable
                                                                                                                          Boolean validateNoPlainTextSecrets,
                                                                                                                          @Nullable
                                                                                                                          IGrantable principal)

(experimental) Convert the environment variables map of string to BuildEnvironmentVariable, which is the customer-facing type, to a list of CfnProject.EnvironmentVariableProperty, which is the representation of environment variables in CloudFormation.

Parameters:: environmentVariables - the map of string to environment variables. This parameter is required.; validateNoPlainTextSecrets - whether to throw an exception if any of the plain text environment variables contain secrets, defaults to 'false'.; principal -
Returns:: an array of CfnProject.EnvironmentVariableProperty instances

serializeEnvVariables

@Stability(value=Experimental)
 @NotNull
public static List<CfnProject.EnvironmentVariableProperty> serializeEnvVariables(@NotNull
                                                                                                                          Map<String,? extends BuildEnvironmentVariable> environmentVariables,
                                                                                                                          @Nullable
                                                                                                                          Boolean validateNoPlainTextSecrets)

Parameters:: environmentVariables - the map of string to environment variables. This parameter is required.; validateNoPlainTextSecrets - whether to throw an exception if any of the plain text environment variables contain secrets, defaults to 'false'.
Returns:: an array of CfnProject.EnvironmentVariableProperty instances

serializeEnvVariables

@Stability(value=Experimental)
 @NotNull
public static List<CfnProject.EnvironmentVariableProperty> serializeEnvVariables(@NotNull
                                                                                                                          Map<String,? extends BuildEnvironmentVariable> environmentVariables)

Parameters:: environmentVariables - the map of string to environment variables. This parameter is required.
Returns:: an array of CfnProject.EnvironmentVariableProperty instances

addFileSystemLocation

@Stability(value=Experimental)
public void addFileSystemLocation(@NotNull
                                                                 IFileSystemLocation fileSystemLocation)

(experimental) Adds a fileSystemLocation to the Project.

Parameters:: fileSystemLocation - the fileSystemLocation to add. This parameter is required.

addSecondaryArtifact
```
@Stability(value=Experimental)
public void addSecondaryArtifact(@NotNull
                                                                IArtifacts secondaryArtifact)
```
(experimental) Adds a secondary artifact to the Project.

Parameters:

secondaryArtifact - the artifact to add as a secondary artifact. This parameter is required.

See Also:

https://docs.aws.amazon.com/codebuild/latest/userguide/sample-multi-in-out.html

addSecondarySource
```
@Stability(value=Experimental)
public void addSecondarySource(@NotNull
                                                              ISource secondarySource)
```
(experimental) Adds a secondary source to the Project.

Parameters:

secondarySource - the source to add as a secondary source. This parameter is required.

See Also:

https://docs.aws.amazon.com/codebuild/latest/userguide/sample-multi-in-out.html

addToRolePolicy

@Stability(value=Experimental)
public void addToRolePolicy(@NotNull
                                                           PolicyStatement statement)

(experimental) Add a permission only if there's a policy attached.

Specified by:: addToRolePolicy in interface IProject
Parameters:: statement - The permissions statement to add. This parameter is required.

bindToCodePipeline

@Stability(value=Experimental)
public void bindToCodePipeline(@NotNull
                                                              software.constructs.Construct _scope,
                                                              @NotNull
                                                              BindToCodePipelineOptions options)

(experimental) A callback invoked when the given project is added to a CodePipeline.

Parameters:: _scope - the construct the binding is taking place in. This parameter is required.; options - additional options for the binding. This parameter is required.

enableBatchBuilds
```
@Stability(value=Experimental)
 @Nullable
public BatchBuildConfig enableBatchBuilds()
```
(experimental) Enable batch builds.
Returns an object contining the batch service role if batch builds could be enabled.

Specified by:

enableBatchBuilds in interface IProject

metric

@Stability(value=Experimental)
 @NotNull
public Metric metric(@NotNull
                                                              String metricName,
                                                              @Nullable
                                                              MetricOptions props)

Specified by:: metric in interface IProject
Parameters:: metricName - The name of the metric. This parameter is required.; props - Customization properties.
Returns:: a CloudWatch metric associated with this build project.

metric

@Stability(value=Experimental)
 @NotNull
public Metric metric(@NotNull
                                                              String metricName)

Specified by:: metric in interface IProject
Parameters:: metricName - The name of the metric. This parameter is required.
Returns:: a CloudWatch metric associated with this build project.

metricBuilds

@Stability(value=Experimental)
 @NotNull
public Metric metricBuilds(@Nullable
                                                                    MetricOptions props)

(experimental) Measures the number of builds triggered.

Units: Count

Valid CloudWatch statistics: Sum

Default: sum over 5 minutes

Specified by:: metricBuilds in interface IProject
Parameters:: props -

metricBuilds
```
@Stability(value=Experimental)
 @NotNull
public Metric metricBuilds()
```
(experimental) Measures the number of builds triggered.
Units: Count
Valid CloudWatch statistics: Sum
Default: sum over 5 minutes

Specified by:

metricBuilds in interface IProject

metricDuration
```
@Stability(value=Experimental)
 @NotNull
public Metric metricDuration(@Nullable
                                                                      MetricOptions props)
```
(experimental) Measures the duration of all builds over time.
Units: Seconds
Valid CloudWatch statistics: Average (recommended), Maximum, Minimum
Default: average over 5 minutes

Specified by:

metricDuration in interface IProject

Parameters:

props -

metricDuration
```
@Stability(value=Experimental)
 @NotNull
public Metric metricDuration()
```
(experimental) Measures the duration of all builds over time.
Units: Seconds
Valid CloudWatch statistics: Average (recommended), Maximum, Minimum
Default: average over 5 minutes

Specified by:

metricDuration in interface IProject

metricFailedBuilds

@Stability(value=Experimental)
 @NotNull
public Metric metricFailedBuilds(@Nullable
                                                                          MetricOptions props)

(experimental) Measures the number of builds that failed because of client error or because of a timeout.

Units: Count

Valid CloudWatch statistics: Sum

Default: sum over 5 minutes

Specified by:: metricFailedBuilds in interface IProject
Parameters:: props -

metricFailedBuilds
```
@Stability(value=Experimental)
 @NotNull
public Metric metricFailedBuilds()
```
(experimental) Measures the number of builds that failed because of client error or because of a timeout.
Units: Count
Valid CloudWatch statistics: Sum
Default: sum over 5 minutes

Specified by:

metricFailedBuilds in interface IProject

metricSucceededBuilds

@Stability(value=Experimental)
 @NotNull
public Metric metricSucceededBuilds(@Nullable
                                                                             MetricOptions props)

(experimental) Measures the number of successful builds.

Units: Count

Valid CloudWatch statistics: Sum

Default: sum over 5 minutes

Specified by:: metricSucceededBuilds in interface IProject
Parameters:: props -

metricSucceededBuilds
```
@Stability(value=Experimental)
 @NotNull
public Metric metricSucceededBuilds()
```
(experimental) Measures the number of successful builds.
Units: Count
Valid CloudWatch statistics: Sum
Default: sum over 5 minutes

Specified by:

metricSucceededBuilds in interface IProject

onBuildFailed

@Stability(value=Experimental)
 @NotNull
public Rule onBuildFailed(@NotNull
                                                                   String id,
                                                                   @Nullable
                                                                   OnEventOptions options)

(experimental) Defines an event rule which triggers when a build fails.

To access fields from the event in the event target input, use the static fields on the StateChangeEvent class.

Specified by:: onBuildFailed in interface IProject
Parameters:: id - This parameter is required.; options -

onBuildFailed
```
@Stability(value=Experimental)
 @NotNull
public Rule onBuildFailed(@NotNull
                                                                   String id)
```
(experimental) Defines an event rule which triggers when a build fails.
To access fields from the event in the event target input, use the static fields on the StateChangeEvent class.

Specified by:

onBuildFailed in interface IProject

Parameters:

id - This parameter is required.

onBuildStarted

@Stability(value=Experimental)
 @NotNull
public Rule onBuildStarted(@NotNull
                                                                    String id,
                                                                    @Nullable
                                                                    OnEventOptions options)

(experimental) Defines an event rule which triggers when a build starts.

To access fields from the event in the event target input, use the static fields on the StateChangeEvent class.

Specified by:: onBuildStarted in interface IProject
Parameters:: id - This parameter is required.; options -

onBuildStarted
```
@Stability(value=Experimental)
 @NotNull
public Rule onBuildStarted(@NotNull
                                                                    String id)
```
(experimental) Defines an event rule which triggers when a build starts.
To access fields from the event in the event target input, use the static fields on the StateChangeEvent class.

Specified by:

onBuildStarted in interface IProject

Parameters:

id - This parameter is required.

onBuildSucceeded

@Stability(value=Experimental)
 @NotNull
public Rule onBuildSucceeded(@NotNull
                                                                      String id,
                                                                      @Nullable
                                                                      OnEventOptions options)

(experimental) Defines an event rule which triggers when a build completes successfully.

To access fields from the event in the event target input, use the static fields on the StateChangeEvent class.

Specified by:: onBuildSucceeded in interface IProject
Parameters:: id - This parameter is required.; options -

onBuildSucceeded
```
@Stability(value=Experimental)
 @NotNull
public Rule onBuildSucceeded(@NotNull
                                                                      String id)
```
(experimental) Defines an event rule which triggers when a build completes successfully.
To access fields from the event in the event target input, use the static fields on the StateChangeEvent class.

Specified by:

onBuildSucceeded in interface IProject

Parameters:

id - This parameter is required.

onEvent

@Stability(value=Experimental)
 @NotNull
public Rule onEvent(@NotNull
                                                             String id,
                                                             @Nullable
                                                             OnEventOptions options)

(experimental) Defines a CloudWatch event rule triggered when something happens with this project.

Specified by:: onEvent in interface IProject
Parameters:: id - This parameter is required.; options -
See Also:: https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-notifications.html

onEvent
```
@Stability(value=Experimental)
 @NotNull
public Rule onEvent(@NotNull
                                                             String id)
```
(experimental) Defines a CloudWatch event rule triggered when something happens with this project.

Specified by:

onEvent in interface IProject

Parameters:

id - This parameter is required.

See Also:

https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-notifications.html

onPhaseChange

@Stability(value=Experimental)
 @NotNull
public Rule onPhaseChange(@NotNull
                                                                   String id,
                                                                   @Nullable
                                                                   OnEventOptions options)

(experimental) Defines a CloudWatch event rule that triggers upon phase change of this build project.

Specified by:: onPhaseChange in interface IProject
Parameters:: id - This parameter is required.; options -
See Also:: https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-notifications.html

onPhaseChange
```
@Stability(value=Experimental)
 @NotNull
public Rule onPhaseChange(@NotNull
                                                                   String id)
```
(experimental) Defines a CloudWatch event rule that triggers upon phase change of this build project.

Specified by:

onPhaseChange in interface IProject

Parameters:

id - This parameter is required.

See Also:

https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-notifications.html

onStateChange

@Stability(value=Experimental)
 @NotNull
public Rule onStateChange(@NotNull
                                                                   String id,
                                                                   @Nullable
                                                                   OnEventOptions options)

(experimental) Defines a CloudWatch event rule triggered when the build project state changes.

You can filter specific build status events using an event pattern filter on the build-status detail field:

 const rule = project.onStateChange('OnBuildStarted', { target });
 rule.addEventPattern({
   detail: {
     'build-status': [
       "IN_PROGRESS",
       "SUCCEEDED",
       "FAILED",
       "STOPPED"
     ]
   }
 });

You can also use the methods onBuildFailed and onBuildSucceeded to define rules for these specific state changes.

To access fields from the event in the event target input, use the static fields on the StateChangeEvent class.

Specified by:: onStateChange in interface IProject
Parameters:: id - This parameter is required.; options -
See Also:: https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-notifications.html

onStateChange
```
@Stability(value=Experimental)
 @NotNull
public Rule onStateChange(@NotNull
                                                                   String id)
```
(experimental) Defines a CloudWatch event rule triggered when the build project state changes.
You can filter specific build status events using an event pattern filter on the build-status detail field:
```
 const rule = project.onStateChange('OnBuildStarted', { target });
 rule.addEventPattern({
   detail: {
     'build-status': [
       "IN_PROGRESS",
       "SUCCEEDED",
       "FAILED",
       "STOPPED"
     ]
   }
 });
 
```
You can also use the methods onBuildFailed and onBuildSucceeded to define rules for these specific state changes.
To access fields from the event in the event target input, use the static fields on the StateChangeEvent class.
Specified by:

onStateChange in interface IProject

Parameters:

id - This parameter is required.

See Also:

https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-notifications.html

getConnections
```
@Stability(value=Experimental)
 @NotNull
public Connections getConnections()
```
(experimental) Access the Connections object.
Will fail if this Project does not have a VPC set.

Specified by:

getConnections in interface IConnectable

getGrantPrincipal
```
@Stability(value=Experimental)
 @NotNull
public IPrincipal getGrantPrincipal()
```
(experimental) The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

getProjectArn
```
@Stability(value=Experimental)
 @NotNull
public String getProjectArn()
```
(experimental) The ARN of the project.

Specified by:

getProjectArn in interface IProject

getProjectName
```
@Stability(value=Experimental)
 @NotNull
public String getProjectName()
```
(experimental) The name of the project.

Specified by:

getProjectName in interface IProject

getRole
```
@Stability(value=Experimental)
 @Nullable
public IRole getRole()
```
(experimental) The IAM role for this project.

Specified by:

getRole in interface IProject

Class Project

Nested Class Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.Resource

Methods inherited from class software.constructs.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awscdk.IResource

Methods inherited from interface software.constructs.IConstruct

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Constructor Detail

Project

Project

Project

Method Detail

fromProjectArn

fromProjectName

serializeEnvVariables

serializeEnvVariables

serializeEnvVariables

addFileSystemLocation

addSecondaryArtifact

addSecondarySource

addToRolePolicy

bindToCodePipeline

enableBatchBuilds

metric

metric

metricBuilds

metricBuilds

metricDuration

metricDuration

metricFailedBuilds

metricFailedBuilds

metricSucceededBuilds

metricSucceededBuilds

onBuildFailed

onBuildFailed

onBuildStarted

onBuildStarted

onBuildSucceeded

onBuildSucceeded

onEvent

onEvent

onPhaseChange

onPhaseChange

onStateChange

onStateChange

getConnections

getGrantPrincipal

getProjectArn

getProjectName

getRole