IProject.Jsii$Default (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

All Superinterfaces:

IConnectable, IConnectable.Jsii$Default, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IGrantable, IGrantable.Jsii$Default, INotificationRuleSource, INotificationRuleSource.Jsii$Default, IProject, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IProject.Jsii$Proxy

Enclosing interface:

IProject
```
@Internal
public static interface IProject.Jsii$Default
extends IProject, IResource.Jsii$Default, INotificationRuleSource.Jsii$Default, IConnectable.Jsii$Default, IGrantable.Jsii$Default
```
Internal default implementation for IProject.

Nested Class Summary
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codebuild.IProject
  IProject.Jsii$Default, IProject.Jsii$Proxy

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default void`	`addToRolePolicy(PolicyStatement policyStatement)`
`default void`	`applyRemovalPolicy(RemovalPolicy policy)` Apply the given removal policy to this resource.
`default NotificationRuleSourceConfig`	`bindAsNotificationRuleSource(software.constructs.Construct scope)` Returns a source configuration for notification rule.
`default BatchBuildConfig`	`enableBatchBuilds()` Enable batch builds.
`default Connections`	`getConnections()` The network connections associated with this resource.
`default ResourceEnvironment`	`getEnv()` The environment this resource belongs to.
`default IPrincipal`	`getGrantPrincipal()` The principal to grant permissions to.
`default software.constructs.Node`	`getNode()` The tree node.
`default String`	`getProjectArn()` The ARN of this Project.
`default String`	`getProjectName()` The human-visible name of this Project.
`default IRole`	`getRole()` The IAM service Role of this Project.
`default Stack`	`getStack()` The stack in which this resource is defined.
`default Metric`	`metric(String metricName, MetricOptions props)`
`default Metric`	`metricBuilds(MetricOptions props)` Measures the number of builds triggered.
`default Metric`	`metricDuration(MetricOptions props)` Measures the duration of all builds over time.
`default Metric`	`metricFailedBuilds(MetricOptions props)` Measures the number of builds that failed because of client error or because of a timeout.
`default Metric`	`metricSucceededBuilds(MetricOptions props)` Measures the number of successful builds.
`default INotificationRule`	`notifyOn(String id, INotificationRuleTarget target, ProjectNotifyOnOptions options)` Defines a CodeStar Notification rule triggered when the project events emitted by you specified, it very similar to `onEvent` API.
`default INotificationRule`	`notifyOnBuildFailed(String id, INotificationRuleTarget target, NotificationRuleOptions options)` Defines a CodeStar notification rule which triggers when a build fails.
`default INotificationRule`	`notifyOnBuildSucceeded(String id, INotificationRuleTarget target, NotificationRuleOptions options)` Defines a CodeStar notification rule which triggers when a build completes successfully.
`default Rule`	`onBuildFailed(String id, OnEventOptions options)` Defines an event rule which triggers when a build fails.
`default Rule`	`onBuildStarted(String id, OnEventOptions options)` Defines an event rule which triggers when a build starts.
`default Rule`	`onBuildSucceeded(String id, OnEventOptions options)` Defines an event rule which triggers when a build completes successfully.
`default Rule`	`onEvent(String id, OnEventOptions options)` Defines a CloudWatch event rule triggered when something happens with this project.
`default Rule`	`onPhaseChange(String id, OnEventOptions options)` Defines a CloudWatch event rule that triggers upon phase change of this build project.
`default Rule`	`onStateChange(String id, OnEventOptions options)` Defines a CloudWatch event rule triggered when the build project state changes.

Methods inherited from interface software.amazon.awscdk.services.codebuild.IProject
metric, metricBuilds, metricDuration, metricFailedBuilds, metricSucceededBuilds, notifyOnBuildFailed, notifyOnBuildSucceeded, onBuildFailed, onBuildStarted, onBuildSucceeded, onEvent, onPhaseChange, onStateChange

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

Method Detail

getNode
```
@Stability(value=Stable)
 @NotNull
default software.constructs.Node getNode()
```
The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv
```
@Stability(value=Stable)
 @NotNull
default ResourceEnvironment getEnv()
```
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack
```
@Stability(value=Stable)
 @NotNull
default Stack getStack()
```
The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getGrantPrincipal
```
@Stability(value=Stable)
 @NotNull
default IPrincipal getGrantPrincipal()
```
The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

Specified by:

getGrantPrincipal in interface IGrantable.Jsii$Default

getConnections
```
@Stability(value=Stable)
 @NotNull
default Connections getConnections()
```
The network connections associated with this resource.

Specified by:

getConnections in interface IConnectable

Specified by:

getConnections in interface IConnectable.Jsii$Default

getProjectArn
```
@Stability(value=Stable)
 @NotNull
default String getProjectArn()
```
The ARN of this Project.

Specified by:

getProjectArn in interface IProject

getProjectName
```
@Stability(value=Stable)
 @NotNull
default String getProjectName()
```
The human-visible name of this Project.

Specified by:

getProjectName in interface IProject

getRole
```
@Stability(value=Stable)
 @Nullable
default IRole getRole()
```
The IAM service Role of this Project.
Undefined for imported Projects.

Specified by:

getRole in interface IProject

applyRemovalPolicy
```
@Stability(value=Stable)
default void applyRemovalPolicy(@NotNull
                                                         RemovalPolicy policy)
```
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

bindAsNotificationRuleSource
```
@Stability(value=Stable)
 @NotNull
default NotificationRuleSourceConfig bindAsNotificationRuleSource(@NotNull
                                                                                                     software.constructs.Construct scope)
```
Returns a source configuration for notification rule.

Specified by:

bindAsNotificationRuleSource in interface INotificationRuleSource

Specified by:

bindAsNotificationRuleSource in interface INotificationRuleSource.Jsii$Default

Parameters:

scope - This parameter is required.

addToRolePolicy

@Stability(value=Stable)
default void addToRolePolicy(@NotNull
                                                      PolicyStatement policyStatement)

Specified by:: addToRolePolicy in interface IProject
Parameters:: policyStatement - This parameter is required.

enableBatchBuilds
```
@Stability(value=Stable)
 @Nullable
default BatchBuildConfig enableBatchBuilds()
```
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=Stable)
 @NotNull
default 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.

metricBuilds

@Stability(value=Stable)
 @NotNull
default Metric metricBuilds(@Nullable
                                                               MetricOptions props)

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 -

metricDuration
```
@Stability(value=Stable)
 @NotNull
default Metric metricDuration(@Nullable
                                                                 MetricOptions props)
```
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 -

metricFailedBuilds

@Stability(value=Stable)
 @NotNull
default Metric metricFailedBuilds(@Nullable
                                                                     MetricOptions props)

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 -

metricSucceededBuilds

@Stability(value=Stable)
 @NotNull
default Metric metricSucceededBuilds(@Nullable
                                                                        MetricOptions props)

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 -

notifyOn

@Stability(value=Stable)
 @NotNull
default INotificationRule notifyOn(@NotNull
                                                                      String id,
                                                                      @NotNull
                                                                      INotificationRuleTarget target,
                                                                      @NotNull
                                                                      ProjectNotifyOnOptions options)

Defines a CodeStar Notification rule triggered when the project events emitted by you specified, it very similar to `onEvent` API.

You can also use the methods notifyOnBuildSucceeded and notifyOnBuildFailed to define rules for these specific event emitted.

Specified by:: notifyOn in interface IProject
Parameters:: id - The logical identifier of the CodeStar Notifications rule that will be created. This parameter is required.; target - The target to register for the CodeStar Notifications destination. This parameter is required.; options - Customization options for CodeStar Notifications rule. This parameter is required.
Returns:: CodeStar Notifications rule associated with this build project.

notifyOnBuildFailed

@Stability(value=Stable)
 @NotNull
default INotificationRule notifyOnBuildFailed(@NotNull
                                                                                 String id,
                                                                                 @NotNull
                                                                                 INotificationRuleTarget target,
                                                                                 @Nullable
                                                                                 NotificationRuleOptions options)

Defines a CodeStar notification rule which triggers when a build fails.

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

notifyOnBuildSucceeded

@Stability(value=Stable)
 @NotNull
default INotificationRule notifyOnBuildSucceeded(@NotNull
                                                                                    String id,
                                                                                    @NotNull
                                                                                    INotificationRuleTarget target,
                                                                                    @Nullable
                                                                                    NotificationRuleOptions options)

Defines a CodeStar notification rule which triggers when a build completes successfully.

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

onBuildFailed

@Stability(value=Stable)
 @NotNull
default Rule onBuildFailed(@NotNull
                                                              String id,
                                                              @Nullable
                                                              OnEventOptions options)

Defines an event rule which triggers when a build fails.

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

onBuildStarted

@Stability(value=Stable)
 @NotNull
default Rule onBuildStarted(@NotNull
                                                               String id,
                                                               @Nullable
                                                               OnEventOptions options)

Defines an event rule which triggers when a build starts.

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

onBuildSucceeded

@Stability(value=Stable)
 @NotNull
default Rule onBuildSucceeded(@NotNull
                                                                 String id,
                                                                 @Nullable
                                                                 OnEventOptions options)

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

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

onEvent

@Stability(value=Stable)
 @NotNull
default Rule onEvent(@NotNull
                                                        String id,
                                                        @Nullable
                                                        OnEventOptions options)

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

onPhaseChange

@Stability(value=Stable)
 @NotNull
default Rule onPhaseChange(@NotNull
                                                              String id,
                                                              @Nullable
                                                              OnEventOptions options)

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

onStateChange

@Stability(value=Stable)
 @NotNull
default Rule onStateChange(@NotNull
                                                              String id,
                                                              @Nullable
                                                              OnEventOptions options)

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

Interface IProject.Jsii$Default

Nested Class Summary

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

Method Summary

Methods inherited from interface software.amazon.awscdk.services.codebuild.IProject

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getNode

getEnv

getStack

getGrantPrincipal

getConnections

getProjectArn

getProjectName

getRole

applyRemovalPolicy

bindAsNotificationRuleSource

addToRolePolicy

enableBatchBuilds

metric

metricBuilds

metricDuration

metricFailedBuilds

metricSucceededBuilds

notifyOn

notifyOnBuildFailed

notifyOnBuildSucceeded

onBuildFailed

onBuildStarted

onBuildSucceeded

onEvent

onPhaseChange

onStateChange