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:

IConstruct, IConstruct.Jsii$Default, IDependable, IDependable.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

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.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default, IConstruct.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.amazon.awscdk.core.IDependable

IDependable.Jsii$Default, IDependable.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.core.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 void	addToRolePolicy(PolicyStatement policyStatement)
final void	applyRemovalPolicy(RemovalPolicy policy)	Apply the given removal policy to this resource.
final NotificationRuleSourceConfig	bindAsNotificationRuleSource(software.constructs.Construct scope)	Returns a source configuration for notification rule.
final BatchBuildConfig	enableBatchBuilds()	Enable batch builds.
final Connections	getConnections()	The network connections associated with this resource.
final ResourceEnvironment	getEnv()	The environment this resource belongs to.
final IPrincipal	getGrantPrincipal()	The principal to grant permissions to.
final ConstructNode	getNode()	The construct tree node for this construct.
final String	getProjectArn()	The ARN of this Project.
final String	getProjectName()	The human-visible name of this Project.
final IRole	getRole()	The IAM service Role of this Project.
final Stack	getStack()	The stack in which this resource is defined.
final Metric	metric(String metricName)
final Metric	metric(String metricName, MetricOptions props)
final Metric	metricBuilds()	Measures the number of builds triggered.
final Metric	metricBuilds(MetricOptions props)	Measures the number of builds triggered.
final Metric	metricDuration()	Measures the duration of all builds over time.
final Metric	metricDuration(MetricOptions props)	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	metricFailedBuilds(MetricOptions props)	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 Metric	metricSucceededBuilds(MetricOptions props)	Measures the number of successful builds.
final 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.
final INotificationRule	notifyOnBuildFailed(String id, INotificationRuleTarget target)	Defines a CodeStar notification rule which triggers when a build fails.
final INotificationRule	notifyOnBuildFailed(String id, INotificationRuleTarget target, NotificationRuleOptions options)	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 INotificationRule	notifyOnBuildSucceeded(String id, INotificationRuleTarget target, NotificationRuleOptions options)	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	onBuildFailed(String id, OnEventOptions options)	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	onBuildStarted(String id, OnEventOptions options)	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	onBuildSucceeded(String id, OnEventOptions options)	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	onEvent(String id, OnEventOptions options)	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	onPhaseChange(String id, OnEventOptions options)	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.
final Rule	onStateChange(String id, OnEventOptions options)	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 Details

Jsii$Proxy

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

Method Details

getNode

@Stability(Stable)
@NotNull
public final ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IConstruct

Specified by:

getNode in interface IConstruct.Jsii$Default

Specified by:

getNode in interface IProject.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
public final 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 IProject.Jsii$Default

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(Stable)
@NotNull
public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IProject.Jsii$Default

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getGrantPrincipal

@Stability(Stable)
@NotNull
public final IPrincipal getGrantPrincipal()

The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

Specified by:

getGrantPrincipal in interface IGrantable.Jsii$Default

Specified by:

getGrantPrincipal in interface IProject.Jsii$Default

getConnections

@Stability(Stable)
@NotNull
public final Connections getConnections()

The network connections associated with this resource.

Specified by:

getConnections in interface IConnectable

Specified by:

getConnections in interface IConnectable.Jsii$Default

Specified by:

getConnections in interface IProject.Jsii$Default

getProjectArn

@Stability(Stable)
@NotNull
public final String getProjectArn()

The ARN of this Project.

Specified by:

getProjectArn in interface IProject

Specified by:

getProjectArn in interface IProject.Jsii$Default

getProjectName

@Stability(Stable)
@NotNull
public final String getProjectName()

The human-visible name of this Project.

Specified by:

getProjectName in interface IProject

Specified by:

getProjectName in interface IProject.Jsii$Default

getRole

@Stability(Stable)
@Nullable
public final IRole getRole()

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

applyRemovalPolicy

@Stability(Stable)
public final 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 IProject.Jsii$Default

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

bindAsNotificationRuleSource

@Stability(Stable)
@NotNull
public final 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

Specified by:

bindAsNotificationRuleSource in interface IProject.Jsii$Default

Parameters:

scope - This parameter is required.

addToRolePolicy

@Stability(Stable)
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(Stable)
@Nullable
public final 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

Specified by:

enableBatchBuilds in interface IProject.Jsii$Default

metric

@Stability(Stable)
@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(Stable)
@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(Stable)
@NotNull
public final 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

Specified by:

metricBuilds in interface IProject.Jsii$Default

Parameters:

props -

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

metricDuration

@Stability(Stable)
@NotNull
public final 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

Specified by:

metricDuration in interface IProject.Jsii$Default

Parameters:

props -

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

metricFailedBuilds

@Stability(Stable)
@NotNull
public final 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

Specified by:

metricFailedBuilds in interface IProject.Jsii$Default

Parameters:

props -

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

metricSucceededBuilds

@Stability(Stable)
@NotNull
public final 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

Specified by:

metricSucceededBuilds in interface IProject.Jsii$Default

Parameters:

props -

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

notifyOn

@Stability(Stable)
@NotNull
public final 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

Specified by:

notifyOn in interface IProject.Jsii$Default

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(Stable)
@NotNull
public final 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

Specified by:

notifyOnBuildFailed in interface IProject.Jsii$Default

Parameters:

id - This parameter is required.

target - This parameter is required.

options -

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

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,
 @Nullable
 NotificationRuleOptions options)

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.

options -

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

Parameters:

id - This parameter is required.

target - This parameter is required.

onBuildFailed

@Stability(Stable)
@NotNull
public final Rule onBuildFailed(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

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

Parameters:

id - This parameter is required.

onBuildStarted

@Stability(Stable)
@NotNull
public final Rule onBuildStarted(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

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

Parameters:

id - This parameter is required.

onBuildSucceeded

@Stability(Stable)
@NotNull
public final 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

Specified by:

onBuildSucceeded in interface IProject.Jsii$Default

Parameters:

id - This parameter is required.

options -

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

Parameters:

id - This parameter is required.

onEvent

@Stability(Stable)
@NotNull
public final 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

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

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,
 @Nullable
 OnEventOptions options)

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

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,
 @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

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

Parameters:

id - This parameter is required.

See Also:

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