Package 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:

IProjectRef, IProjectRef.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IResource, IResource.Jsii$Default, IProject, IProject.Jsii$Default, INotificationRuleSource, INotificationRuleSource.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.ec2.IConnectable

IConnectable.Jsii$Default, IConnectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IDependable

software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

IEnvironmentAware.Jsii$Default, IEnvironmentAware.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IGrantable

IGrantable.Jsii$Default, IGrantable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codestarnotifications.INotificationRuleSource

INotificationRuleSource.Jsii$Default, INotificationRuleSource.Jsii$Proxy

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

IProject.Jsii$Default, IProject.Jsii$Proxy

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

IProjectRef.Jsii$Default, IProjectRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final Metric	metric(String metricName)
final Metric	metricBuilds()	Measures the number of builds triggered.
final Metric	metricDuration()	Measures the duration of all builds over time.
final Metric	metricFailedBuilds()	Measures the number of builds that failed because of client error or because of a timeout.
final Metric	metricSucceededBuilds()	Measures the number of successful builds.
final INotificationRule	notifyOnBuildFailed(String id, INotificationRuleTarget target)	Defines a CodeStar notification rule which triggers when a build fails.
final INotificationRule	notifyOnBuildSucceeded(String id, INotificationRuleTarget target)	Defines a CodeStar notification rule which triggers when a build completes successfully.
final Rule	onBuildFailed(String id)	Defines an event rule which triggers when a build fails.
final Rule	onBuildStarted(String id)	Defines an event rule which triggers when a build starts.
final Rule	onBuildSucceeded(String id)	Defines an event rule which triggers when a build completes successfully.
final Rule	onEvent(String id)	Defines a CloudWatch event rule triggered when something happens with this project.
final Rule	onPhaseChange(String id)	Defines a CloudWatch event rule that triggers upon phase change of this build project.
final Rule	onStateChange(String id)	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.awscdk.services.ec2.IConnectable.Jsii$Default

getConnections

Methods inherited from interface software.constructs.IConstruct.Jsii$Default

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware.Jsii$Default

getEnv

Methods inherited from interface software.amazon.awscdk.services.iam.IGrantable.Jsii$Default

getGrantPrincipal

Methods inherited from interface software.amazon.awscdk.services.codestarnotifications.INotificationRuleSource.Jsii$Default

bindAsNotificationRuleSource

Methods inherited from interface software.amazon.awscdk.services.codebuild.IProject.Jsii$Default

addToRolePolicy, enableBatchBuilds, getProjectArn, getProjectName, getRole, metric, metricBuilds, metricDuration, metricFailedBuilds, metricSucceededBuilds, notifyOn, notifyOnBuildFailed, notifyOnBuildSucceeded, onBuildFailed, onBuildStarted, onBuildSucceeded, onEvent, onPhaseChange, onStateChange

Methods inherited from interface software.amazon.awscdk.interfaces.codebuild.IProjectRef.Jsii$Default

getProjectRef

Methods inherited from interface software.amazon.awscdk.IResource.Jsii$Default

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Jsii$Proxy

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

Method Details

metric

@Stability(Stable)
@NotNull
public final Metric metric(@NotNull
 String metricName)

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.

Returns:

a CloudWatch metric associated with this build project.

metricBuilds

@Stability(Stable)
@NotNull
public final Metric metricBuilds()

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

metricDuration

@Stability(Stable)
@NotNull
public final Metric metricDuration()

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

metricFailedBuilds

@Stability(Stable)
@NotNull
public final Metric metricFailedBuilds()

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

metricSucceededBuilds

@Stability(Stable)
@NotNull
public final Metric metricSucceededBuilds()

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

notifyOnBuildFailed

@Stability(Stable)
@NotNull
public final INotificationRule notifyOnBuildFailed(@NotNull
 String id,
 @NotNull
 INotificationRuleTarget target)

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

Specified by:

notifyOnBuildFailed in interface IProject

Specified by:

notifyOnBuildFailed in interface IProject.Jsii$Default

Parameters:

id - This parameter is required.

target - This parameter is required.

notifyOnBuildSucceeded

@Stability(Stable)
@NotNull
public final INotificationRule notifyOnBuildSucceeded(@NotNull
 String id,
 @NotNull
 INotificationRuleTarget target)

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

Specified by:

notifyOnBuildSucceeded in interface IProject

Specified by:

notifyOnBuildSucceeded in interface IProject.Jsii$Default

Parameters:

id - This parameter is required.

target - This parameter is required.

onBuildFailed

@Stability(Stable)
@NotNull
public final Rule onBuildFailed(@NotNull
 String id)

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.

onBuildStarted

@Stability(Stable)
@NotNull
public final Rule onBuildStarted(@NotNull
 String id)

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.

onBuildSucceeded

@Stability(Stable)
@NotNull
public final Rule onBuildSucceeded(@NotNull
 String id)

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.

onEvent

@Stability(Stable)
@NotNull
public final Rule onEvent(@NotNull
 String id)

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.

See Also:

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

onPhaseChange

@Stability(Stable)
@NotNull
public final Rule onPhaseChange(@NotNull
 String id)

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.

See Also:

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

onStateChange

@Stability(Stable)
@NotNull
public final Rule onStateChange(@NotNull
 String id)

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.

See Also:

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