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

Enclosing interface:

IProject

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 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)
void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
NotificationRuleSourceConfig	bindAsNotificationRuleSource(software.constructs.Construct scope) Returns a source configuration for notification rule.
BatchBuildConfig	enableBatchBuilds() Enable batch builds.
Connections	getConnections() The network connections associated with this resource.
ResourceEnvironment	getEnv() The environment this resource belongs to.
IPrincipal	getGrantPrincipal() The principal to grant permissions to.
ConstructNode	getNode() The construct tree node for this construct.
java.lang.String	getProjectArn() The ARN of this Project.
java.lang.String	getProjectName() The human-visible name of this Project.
IRole	getRole() The IAM service Role of this Project.
Stack	getStack() The stack in which this resource is defined.
Metric	metric(java.lang.String metricName)
Metric	metric(java.lang.String metricName, MetricOptions props)
Metric	metricBuilds() Measures the number of builds triggered.
Metric	metricBuilds(MetricOptions props) Measures the number of builds triggered.
Metric	metricDuration() Measures the duration of all builds over time.
Metric	metricDuration(MetricOptions props) Measures the duration of all builds over time.
Metric	metricFailedBuilds() Measures the number of builds that failed because of client error or because of a timeout.
Metric	metricFailedBuilds(MetricOptions props) Measures the number of builds that failed because of client error or because of a timeout.
Metric	metricSucceededBuilds() Measures the number of successful builds.
Metric	metricSucceededBuilds(MetricOptions props) Measures the number of successful builds.
INotificationRule	notifyOn(java.lang.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.
INotificationRule	notifyOnBuildFailed(java.lang.String id, INotificationRuleTarget target) Defines a CodeStar notification rule which triggers when a build fails.
INotificationRule	notifyOnBuildFailed(java.lang.String id, INotificationRuleTarget target, NotificationRuleOptions options) Defines a CodeStar notification rule which triggers when a build fails.
INotificationRule	notifyOnBuildSucceeded(java.lang.String id, INotificationRuleTarget target) Defines a CodeStar notification rule which triggers when a build completes successfully.
INotificationRule	notifyOnBuildSucceeded(java.lang.String id, INotificationRuleTarget target, NotificationRuleOptions options) Defines a CodeStar notification rule which triggers when a build completes successfully.
Rule	onBuildFailed(java.lang.String id) Defines an event rule which triggers when a build fails.
Rule	onBuildFailed(java.lang.String id, OnEventOptions options) Defines an event rule which triggers when a build fails.
Rule	onBuildStarted(java.lang.String id) Defines an event rule which triggers when a build starts.
Rule	onBuildStarted(java.lang.String id, OnEventOptions options) Defines an event rule which triggers when a build starts.
Rule	onBuildSucceeded(java.lang.String id) Defines an event rule which triggers when a build completes successfully.
Rule	onBuildSucceeded(java.lang.String id, OnEventOptions options) Defines an event rule which triggers when a build completes successfully.
Rule	onEvent(java.lang.String id) Defines a CloudWatch event rule triggered when something happens with this project.
Rule	onEvent(java.lang.String id, OnEventOptions options) Defines a CloudWatch event rule triggered when something happens with this project.
Rule	onPhaseChange(java.lang.String id) Defines a CloudWatch event rule that triggers upon phase change of this build project.
Rule	onPhaseChange(java.lang.String id, OnEventOptions options) Defines a CloudWatch event rule that triggers upon phase change of this build project.
Rule	onStateChange(java.lang.String id) Defines a CloudWatch event rule triggered when the build project state changes.
Rule	onStateChange(java.lang.String id, OnEventOptions options) Defines a CloudWatch event rule triggered when the build project state changes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Jsii$Proxy

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

Method Detail

getNode

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 IResource.Jsii$Default

Specified by:

getNode in interface IProject.Jsii$Default

getEnv

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 IResource

Specified by:

getEnv in interface IResource.Jsii$Default

Specified by:

getEnv in interface IProject.Jsii$Default

getStack

public final Stack getStack()

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

public final IPrincipal getGrantPrincipal()

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

public final Connections getConnections()

The network connections associated with this resource.

Specified by:

getConnections in interface IProject.Jsii$Default

Specified by:

getConnections in interface IConnectable

Specified by:

getConnections in interface IConnectable.Jsii$Default

getProjectArn

public final java.lang.String getProjectArn()

The ARN of this Project.

Specified by:

getProjectArn in interface IProject

Specified by:

getProjectArn in interface IProject.Jsii$Default

getProjectName

public final java.lang.String getProjectName()

The human-visible name of this Project.

Specified by:

getProjectName in interface IProject

Specified by:

getProjectName in interface IProject.Jsii$Default

getRole

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

public final void applyRemovalPolicy(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

Specified by:

applyRemovalPolicy in interface IProject.Jsii$Default

Parameters:

policy - This parameter is required.

bindAsNotificationRuleSource

public final NotificationRuleSourceConfig bindAsNotificationRuleSource(software.constructs.Construct scope)

Returns a source configuration for notification rule.

Specified by:

bindAsNotificationRuleSource in interface IProject.Jsii$Default

Specified by:

bindAsNotificationRuleSource in interface INotificationRuleSource

Specified by:

bindAsNotificationRuleSource in interface INotificationRuleSource.Jsii$Default

Parameters:

scope - This parameter is required.

addToRolePolicy

public final void addToRolePolicy(PolicyStatement policyStatement)

Specified by:

addToRolePolicy in interface IProject

Specified by:

addToRolePolicy in interface IProject.Jsii$Default

Parameters:

policyStatement - This parameter is required.

enableBatchBuilds

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

public final Metric metric(java.lang.String metricName,
                           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

public final Metric metric(java.lang.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

public final Metric metricBuilds(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

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

public final Metric metricDuration(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

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

public final Metric metricFailedBuilds(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

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

public final Metric metricSucceededBuilds(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

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

public final INotificationRule notifyOn(java.lang.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.

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

public final INotificationRule notifyOnBuildFailed(java.lang.String id,
                                                   INotificationRuleTarget target,
                                                   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

public final INotificationRule notifyOnBuildFailed(java.lang.String id,
                                                   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

public final INotificationRule notifyOnBuildSucceeded(java.lang.String id,
                                                      INotificationRuleTarget target,
                                                      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

public final INotificationRule notifyOnBuildSucceeded(java.lang.String id,
                                                      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

public final Rule onBuildFailed(java.lang.String id,
                                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

public final Rule onBuildFailed(java.lang.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

public final Rule onBuildStarted(java.lang.String id,
                                 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

public final Rule onBuildStarted(java.lang.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

public final Rule onBuildSucceeded(java.lang.String id,
                                   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

public final Rule onBuildSucceeded(java.lang.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

public final Rule onEvent(java.lang.String id,
                          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

public final Rule onEvent(java.lang.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

public final Rule onPhaseChange(java.lang.String id,
                                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

public final Rule onPhaseChange(java.lang.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

public final Rule onStateChange(java.lang.String id,
                                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

public final Rule onStateChange(java.lang.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