software.amazon.awscdk.services.codebuild

Class IProject.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.codebuild.IProject.Jsii$Proxy

All Implemented Interfaces:

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

Enclosing interface:

IProject

@Internal
public static final class IProject.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IProject.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addToRolePolicy(PolicyStatement policyStatement)
BatchBuildConfig	enableBatchBuilds() (experimental) Enable batch builds.
Connections	getConnections()
ResourceEnvironment	getEnv() (experimental) The environment this resource belongs to.
IPrincipal	getGrantPrincipal() (experimental) The principal to grant permissions to.
software.constructs.Node	getNode() The tree node.
String	getProjectArn() (experimental) The ARN of this Project.
String	getProjectName() (experimental) The human-visible name of this Project.
IRole	getRole() (experimental) The IAM service Role of this Project.
Stack	getStack() (experimental) The stack in which this resource is defined.
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.

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
public final software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface IProject.Jsii$Default

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

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

getEnv

@Stability(value=Experimental)
 @NotNull
public final ResourceEnvironment getEnv()

(experimental) 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

Specified by:

getEnv in interface IProject.Jsii$Default

getStack

@Stability(value=Experimental)
 @NotNull
public final Stack getStack()

(experimental) The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface IProject.Jsii$Default

getGrantPrincipal

@Stability(value=Experimental)
 @NotNull
public final IPrincipal getGrantPrincipal()

(experimental) The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IProject.Jsii$Default

Specified by:

getGrantPrincipal in interface IGrantable

Specified by:

getGrantPrincipal in interface IGrantable.Jsii$Default

getConnections

@Stability(value=Experimental)
 @NotNull
public final Connections getConnections()

Specified by:

getConnections in interface IProject.Jsii$Default

Specified by:

getConnections in interface IConnectable

Specified by:

getConnections in interface IConnectable.Jsii$Default

getProjectArn

@Stability(value=Experimental)
 @NotNull
public final String getProjectArn()

(experimental) The ARN of this Project.

Specified by:

getProjectArn in interface IProject

Specified by:

getProjectArn in interface IProject.Jsii$Default

getProjectName

@Stability(value=Experimental)
 @NotNull
public final String getProjectName()

(experimental) The human-visible name of this Project.

Specified by:

getProjectName in interface IProject

Specified by:

getProjectName in interface IProject.Jsii$Default

getRole

@Stability(value=Experimental)
 @Nullable
public final IRole getRole()

(experimental) The IAM service Role of this Project.

Undefined for imported Projects.

Specified by:

getRole in interface IProject

Specified by:

getRole in interface IProject.Jsii$Default

addToRolePolicy

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

Specified by:

addToRolePolicy in interface IProject

Specified by:

addToRolePolicy in interface IProject.Jsii$Default

Parameters:

policyStatement - This parameter is required.

enableBatchBuilds

@Stability(value=Experimental)
 @Nullable
public final 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

Specified by:

enableBatchBuilds in interface IProject.Jsii$Default

metric

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

Specified by:

metric in interface IProject

Specified by:

metric in interface IProject.Jsii$Default

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 final 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 final 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

Specified by:

metricBuilds in interface IProject.Jsii$Default

Parameters:

props -

metricBuilds

@Stability(value=Experimental)
 @NotNull
public final 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 final 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

Specified by:

metricDuration in interface IProject.Jsii$Default

Parameters:

props -

metricDuration

@Stability(value=Experimental)
 @NotNull
public final 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 final 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

Specified by:

metricFailedBuilds in interface IProject.Jsii$Default

Parameters:

props -

metricFailedBuilds

@Stability(value=Experimental)
 @NotNull
public final 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 final 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

Specified by:

metricSucceededBuilds in interface IProject.Jsii$Default

Parameters:

props -

metricSucceededBuilds

@Stability(value=Experimental)
 @NotNull
public final 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 final Rule onBuildFailed(@NotNull
                                                                         String id,
                                                                         @Nullable
                                                                         OnEventOptions options)

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

Specified by:

onBuildFailed in interface IProject

Specified by:

onBuildFailed in interface IProject.Jsii$Default

Parameters:

id - This parameter is required.

options -

onBuildFailed

@Stability(value=Experimental)
 @NotNull
public final Rule onBuildFailed(@NotNull
                                                                         String id)

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

Specified by:

onBuildFailed in interface IProject

Parameters:

id - This parameter is required.

onBuildStarted

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

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

Specified by:

onBuildStarted in interface IProject

Specified by:

onBuildStarted in interface IProject.Jsii$Default

Parameters:

id - This parameter is required.

options -

onBuildStarted

@Stability(value=Experimental)
 @NotNull
public final Rule onBuildStarted(@NotNull
                                                                          String id)

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

Specified by:

onBuildStarted in interface IProject

Parameters:

id - This parameter is required.

onBuildSucceeded

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

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

Specified by:

onBuildSucceeded in interface IProject

Specified by:

onBuildSucceeded in interface IProject.Jsii$Default

Parameters:

id - This parameter is required.

options -

onBuildSucceeded

@Stability(value=Experimental)
 @NotNull
public final Rule onBuildSucceeded(@NotNull
                                                                            String id)

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

Specified by:

onBuildSucceeded in interface IProject

Parameters:

id - This parameter is required.

onEvent

@Stability(value=Experimental)
 @NotNull
public final 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

Specified by:

onEvent in interface IProject.Jsii$Default

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 final 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 final 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

Specified by:

onPhaseChange in interface IProject.Jsii$Default

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 final 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 final 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

Specified by:

onStateChange in interface IProject.Jsii$Default

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 final 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