software.amazon.awscdk.services.codebuild

Class ProjectRef

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Construct

software.amazon.awscdk.services.codebuild.ProjectRef

All Implemented Interfaces:

software.amazon.awscdk.services.events.IEventRuleTarget, software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

Project

@Generated(value="jsii-pacmak/0.7.6 (build 04cb6bb)",
           date="2018-09-27T21:49:26.397Z")
public abstract class ProjectRef
extends software.amazon.awscdk.Construct
implements software.amazon.awscdk.services.events.IEventRuleTarget

Represents a reference to a CodeBuild Project. If you're managing the Project alongside the rest of your CDK resources, use the Project class. If you want to reference an already existing Project (or one defined in a different CDK Stack), use the import method.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProjectRef(software.amazon.jsii.JsiiObject.InitializationMode mode)

Method Summary

Modifier and Type	Method and Description
PipelineBuildAction	addBuildToPipeline(software.amazon.awscdk.services.codepipeline.api.IStage stage, String name, CommonPipelineBuildActionProps props) Convenience method for creating a new PipelineBuildAction build Action, and adding it to the given Stage.
software.amazon.awscdk.services.events.EventRuleTargetProps	asEventRuleTarget(String _ruleArn, String _ruleId) Allows using build projects as event rule targets.
ProjectRefProps	export() Export this Project.
String	getProjectArn() The ARN of this Project.
String	getProjectName() The human-visible name of this Project.
software.amazon.awscdk.services.iam.Role	getRole() The IAM service Role of this Project.
static ProjectRef	import_(software.amazon.awscdk.Construct parent, String name, ProjectRefProps props) Import a Project defined either outside the CDK, or in a different CDK Stack (and exported using the export method).
software.amazon.awscdk.services.cloudwatch.Metric	metric(String metricName, software.amazon.awscdk.services.cloudwatch.MetricCustomization props)
software.amazon.awscdk.services.cloudwatch.Metric	metricBuilds() Measures the number of builds triggered.
software.amazon.awscdk.services.cloudwatch.Metric	metricBuilds(software.amazon.awscdk.services.cloudwatch.MetricCustomization props) Measures the number of builds triggered.
software.amazon.awscdk.services.cloudwatch.Metric	metricDuration() Measures the duration of all builds over time.
software.amazon.awscdk.services.cloudwatch.Metric	metricDuration(software.amazon.awscdk.services.cloudwatch.MetricCustomization props) Measures the duration of all builds over time.
software.amazon.awscdk.services.cloudwatch.Metric	metricFailedBuilds() Measures the number of builds that failed because of client error or because of a timeout.
software.amazon.awscdk.services.cloudwatch.Metric	metricFailedBuilds(software.amazon.awscdk.services.cloudwatch.MetricCustomization props) Measures the number of builds that failed because of client error or because of a timeout.
software.amazon.awscdk.services.cloudwatch.Metric	metricSucceededBuilds() Measures the number of successful builds.
software.amazon.awscdk.services.cloudwatch.Metric	metricSucceededBuilds(software.amazon.awscdk.services.cloudwatch.MetricCustomization props) Measures the number of successful builds.
software.amazon.awscdk.services.events.EventRule	onBuildFailed(String name) Defines an event rule which triggers when a build fails.
software.amazon.awscdk.services.events.EventRule	onBuildFailed(String name, software.amazon.awscdk.services.events.IEventRuleTarget target) Defines an event rule which triggers when a build fails.
software.amazon.awscdk.services.events.EventRule	onBuildFailed(String name, software.amazon.awscdk.services.events.IEventRuleTarget target, software.amazon.awscdk.services.events.EventRuleProps options) Defines an event rule which triggers when a build fails.
software.amazon.awscdk.services.events.EventRule	onBuildStarted(String name) Defines an event rule which triggers when a build starts.
software.amazon.awscdk.services.events.EventRule	onBuildStarted(String name, software.amazon.awscdk.services.events.IEventRuleTarget target) Defines an event rule which triggers when a build starts.
software.amazon.awscdk.services.events.EventRule	onBuildStarted(String name, software.amazon.awscdk.services.events.IEventRuleTarget target, software.amazon.awscdk.services.events.EventRuleProps options) Defines an event rule which triggers when a build starts.
software.amazon.awscdk.services.events.EventRule	onBuildSucceeded(String name) Defines an event rule which triggers when a build completes successfully.
software.amazon.awscdk.services.events.EventRule	onBuildSucceeded(String name, software.amazon.awscdk.services.events.IEventRuleTarget target) Defines an event rule which triggers when a build completes successfully.
software.amazon.awscdk.services.events.EventRule	onBuildSucceeded(String name, software.amazon.awscdk.services.events.IEventRuleTarget target, software.amazon.awscdk.services.events.EventRuleProps options) Defines an event rule which triggers when a build completes successfully.
software.amazon.awscdk.services.events.EventRule	onPhaseChange(String name) Defines a CloudWatch event rule that triggers upon phase change of this build project.
software.amazon.awscdk.services.events.EventRule	onPhaseChange(String name, software.amazon.awscdk.services.events.IEventRuleTarget target) Defines a CloudWatch event rule that triggers upon phase change of this build project.
software.amazon.awscdk.services.events.EventRule	onPhaseChange(String name, software.amazon.awscdk.services.events.IEventRuleTarget target, software.amazon.awscdk.services.events.EventRuleProps options) Defines a CloudWatch event rule that triggers upon phase change of this build project.
software.amazon.awscdk.services.events.EventRule	onStateChange(String name) Defines a CloudWatch event rule triggered when the build project state changes.
software.amazon.awscdk.services.events.EventRule	onStateChange(String name, software.amazon.awscdk.services.events.IEventRuleTarget target) Defines a CloudWatch event rule triggered when the build project state changes.
software.amazon.awscdk.services.events.EventRule	onStateChange(String name, software.amazon.awscdk.services.events.IEventRuleTarget target, software.amazon.awscdk.services.events.EventRuleProps options) Defines a CloudWatch event rule triggered when the build project state changes.

Methods inherited from class software.amazon.awscdk.Construct

addChild, addError, addInfo, addMetadata, addMetadata, addMetadata, addWarning, ancestors, ancestors, findChild, getChildren, getContext, getId, getLocked, getMetadata, getParent, getPath, getUniqueId, lock, requireContext, required, setContext, setContext, toString, toTreeString, toTreeString, tryFindChild, unlock, validate, validateTree

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectRef

protected ProjectRef(software.amazon.jsii.JsiiObject.InitializationMode mode)

Method Detail

import_

public static ProjectRef import_(software.amazon.awscdk.Construct parent,
                                 String name,
                                 ProjectRefProps props)

Import a Project defined either outside the CDK, or in a different CDK Stack (and exported using the export method).

Parameters:

parent - the parent Construct for this Construct

name - the logical name of this Construct

props - the properties of the referenced Project

Returns:

a reference to the existing Project

addBuildToPipeline

public PipelineBuildAction addBuildToPipeline(software.amazon.awscdk.services.codepipeline.api.IStage stage,
                                              String name,
                                              CommonPipelineBuildActionProps props)

Convenience method for creating a new PipelineBuildAction build Action, and adding it to the given Stage.

Parameters:

stage - the Pipeline Stage to add the new Action to

name - the name of the newly created Action

props - the properties of the new Action

Returns:

the newly created PipelineBuildAction build Action

asEventRuleTarget

public software.amazon.awscdk.services.events.EventRuleTargetProps asEventRuleTarget(String _ruleArn,
                                                                                     String _ruleId)

Allows using build projects as event rule targets.

Specified by:

asEventRuleTarget in interface software.amazon.awscdk.services.events.IEventRuleTarget

export

public ProjectRefProps export()

Export this Project. Allows referencing this Project in a different CDK Stack.

metric

public software.amazon.awscdk.services.cloudwatch.Metric metric(String metricName,
                                                                software.amazon.awscdk.services.cloudwatch.MetricCustomization props)

Parameters:

metricName - The name of the metric

props - Customization properties

Returns:

a CloudWatch metric associated with this build project.

metricBuilds

public software.amazon.awscdk.services.cloudwatch.Metric metricBuilds(@Nullable
                                                                      software.amazon.awscdk.services.cloudwatch.MetricCustomization props)

Measures the number of builds triggered. Units: Count Valid CloudWatch statistics: Sum

metricBuilds

public software.amazon.awscdk.services.cloudwatch.Metric metricBuilds()

Measures the number of builds triggered. Units: Count Valid CloudWatch statistics: Sum

metricDuration

public software.amazon.awscdk.services.cloudwatch.Metric metricDuration(@Nullable
                                                                        software.amazon.awscdk.services.cloudwatch.MetricCustomization props)

Measures the duration of all builds over time. Units: Seconds Valid CloudWatch statistics: Average (recommended), Maximum, Minimum

metricDuration

public software.amazon.awscdk.services.cloudwatch.Metric metricDuration()

Measures the duration of all builds over time. Units: Seconds Valid CloudWatch statistics: Average (recommended), Maximum, Minimum

metricFailedBuilds

public software.amazon.awscdk.services.cloudwatch.Metric metricFailedBuilds(@Nullable
                                                                            software.amazon.awscdk.services.cloudwatch.MetricCustomization props)

Measures the number of builds that failed because of client error or because of a timeout. Units: Count Valid CloudWatch statistics: Sum

metricFailedBuilds

public software.amazon.awscdk.services.cloudwatch.Metric metricFailedBuilds()

Measures the number of builds that failed because of client error or because of a timeout. Units: Count Valid CloudWatch statistics: Sum

metricSucceededBuilds

public software.amazon.awscdk.services.cloudwatch.Metric metricSucceededBuilds(@Nullable
                                                                               software.amazon.awscdk.services.cloudwatch.MetricCustomization props)

Measures the number of successful builds. Units: Count Valid CloudWatch statistics: Sum

metricSucceededBuilds

public software.amazon.awscdk.services.cloudwatch.Metric metricSucceededBuilds()

Measures the number of successful builds. Units: Count Valid CloudWatch statistics: Sum

onBuildFailed

public software.amazon.awscdk.services.events.EventRule onBuildFailed(String name,
                                                                      @Nullable
                                                                      software.amazon.awscdk.services.events.IEventRuleTarget target,
                                                                      @Nullable
                                                                      software.amazon.awscdk.services.events.EventRuleProps options)

Defines an event rule which triggers when a build fails.

onBuildFailed

public software.amazon.awscdk.services.events.EventRule onBuildFailed(String name,
                                                                      @Nullable
                                                                      software.amazon.awscdk.services.events.IEventRuleTarget target)

Defines an event rule which triggers when a build fails.

onBuildFailed

public software.amazon.awscdk.services.events.EventRule onBuildFailed(String name)

Defines an event rule which triggers when a build fails.

onBuildStarted

public software.amazon.awscdk.services.events.EventRule onBuildStarted(String name,
                                                                       @Nullable
                                                                       software.amazon.awscdk.services.events.IEventRuleTarget target,
                                                                       @Nullable
                                                                       software.amazon.awscdk.services.events.EventRuleProps options)

Defines an event rule which triggers when a build starts.

onBuildStarted

public software.amazon.awscdk.services.events.EventRule onBuildStarted(String name,
                                                                       @Nullable
                                                                       software.amazon.awscdk.services.events.IEventRuleTarget target)

Defines an event rule which triggers when a build starts.

onBuildStarted

public software.amazon.awscdk.services.events.EventRule onBuildStarted(String name)

Defines an event rule which triggers when a build starts.

onBuildSucceeded

public software.amazon.awscdk.services.events.EventRule onBuildSucceeded(String name,
                                                                         @Nullable
                                                                         software.amazon.awscdk.services.events.IEventRuleTarget target,
                                                                         @Nullable
                                                                         software.amazon.awscdk.services.events.EventRuleProps options)

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

onBuildSucceeded

public software.amazon.awscdk.services.events.EventRule onBuildSucceeded(String name,
                                                                         @Nullable
                                                                         software.amazon.awscdk.services.events.IEventRuleTarget target)

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

onBuildSucceeded

public software.amazon.awscdk.services.events.EventRule onBuildSucceeded(String name)

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

onPhaseChange

public software.amazon.awscdk.services.events.EventRule onPhaseChange(String name,
                                                                      @Nullable
                                                                      software.amazon.awscdk.services.events.IEventRuleTarget target,
                                                                      @Nullable
                                                                      software.amazon.awscdk.services.events.EventRuleProps options)

Defines a CloudWatch event rule that triggers upon phase change of this build project.

See Also:

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

onPhaseChange

public software.amazon.awscdk.services.events.EventRule onPhaseChange(String name,
                                                                      @Nullable
                                                                      software.amazon.awscdk.services.events.IEventRuleTarget target)

Defines a CloudWatch event rule that triggers upon phase change of this build project.

See Also:

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

onPhaseChange

public software.amazon.awscdk.services.events.EventRule onPhaseChange(String name)

Defines a CloudWatch event rule that triggers upon phase change of this build project.

See Also:

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

onStateChange

public software.amazon.awscdk.services.events.EventRule onStateChange(String name,
                                                                      @Nullable
                                                                      software.amazon.awscdk.services.events.IEventRuleTarget target,
                                                                      @Nullable
                                                                      software.amazon.awscdk.services.events.EventRuleProps 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.

See Also:

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

onStateChange

public software.amazon.awscdk.services.events.EventRule onStateChange(String name,
                                                                      @Nullable
                                                                      software.amazon.awscdk.services.events.IEventRuleTarget target)

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.

See Also:

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

onStateChange

public software.amazon.awscdk.services.events.EventRule onStateChange(String name)

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.

See Also:

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

getProjectArn

public String getProjectArn()

The ARN of this Project.

getProjectName

public String getProjectName()

The human-visible name of this Project.

getRole

@Nullable
public software.amazon.awscdk.services.iam.Role getRole()

The IAM service Role of this Project. Undefined for imported Projects.