Interface IProject.Jsii$Default
- All Superinterfaces:
IConnectable
,IConnectable.Jsii$Default
,IConstruct
,software.constructs.IConstruct
,IConstruct.Jsii$Default
,software.constructs.IConstruct.Jsii$Default
,IDependable
,IDependable.Jsii$Default
,IGrantable
,IGrantable.Jsii$Default
,INotificationRuleSource
,INotificationRuleSource.Jsii$Default
,IProject
,IResource
,IResource.Jsii$Default
,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
IProject.Jsii$Proxy
- Enclosing interface:
IProject
IProject
.-
Nested Class Summary
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
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
addToRolePolicy
(PolicyStatement policyStatement) default void
applyRemovalPolicy
(RemovalPolicy policy) Apply the given removal policy to this resource.default NotificationRuleSourceConfig
bindAsNotificationRuleSource
(software.constructs.Construct scope) Returns a source configuration for notification rule.default BatchBuildConfig
Enable batch builds.default Connections
The network connections associated with this resource.default ResourceEnvironment
getEnv()
The environment this resource belongs to.default IPrincipal
The principal to grant permissions to.default ConstructNode
getNode()
The construct tree node for this construct.default String
The ARN of this Project.default String
The human-visible name of this Project.default IRole
getRole()
The IAM service Role of this Project.default Stack
getStack()
The stack in which this resource is defined.default Metric
metric
(String metricName, MetricOptions props) default Metric
metricBuilds
(MetricOptions props) Measures the number of builds triggered.default Metric
metricDuration
(MetricOptions props) Measures the duration of all builds over time.default Metric
metricFailedBuilds
(MetricOptions props) Measures the number of builds that failed because of client error or because of a timeout.default Metric
Measures the number of successful builds.default 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 toonEvent
API.default INotificationRule
notifyOnBuildFailed
(String id, INotificationRuleTarget target, NotificationRuleOptions options) Defines a CodeStar notification rule which triggers when a build fails.default INotificationRule
notifyOnBuildSucceeded
(String id, INotificationRuleTarget target, NotificationRuleOptions options) Defines a CodeStar notification rule which triggers when a build completes successfully.default Rule
onBuildFailed
(String id, OnEventOptions options) Defines an event rule which triggers when a build fails.default Rule
onBuildStarted
(String id, OnEventOptions options) Defines an event rule which triggers when a build starts.default Rule
onBuildSucceeded
(String id, OnEventOptions options) Defines an event rule which triggers when a build completes successfully.default Rule
onEvent
(String id, OnEventOptions options) Defines a CloudWatch event rule triggered when something happens with this project.default Rule
onPhaseChange
(String id, OnEventOptions options) Defines a CloudWatch event rule that triggers upon phase change of this build project.default Rule
onStateChange
(String id, OnEventOptions options) Defines a CloudWatch event rule triggered when the build project state changes.Methods inherited from interface software.amazon.awscdk.services.codebuild.IProject
metric, metricBuilds, metricDuration, metricFailedBuilds, metricSucceededBuilds, notifyOnBuildFailed, notifyOnBuildSucceeded, onBuildFailed, onBuildStarted, onBuildSucceeded, onEvent, onPhaseChange, onStateChange
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getNode
The construct tree node for this construct.- Specified by:
getNode
in interfaceIConstruct
- Specified by:
getNode
in interfaceIConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
-
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 interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
-
getGrantPrincipal
The principal to grant permissions to.- Specified by:
getGrantPrincipal
in interfaceIGrantable
- Specified by:
getGrantPrincipal
in interfaceIGrantable.Jsii$Default
-
getConnections
The network connections associated with this resource.- Specified by:
getConnections
in interfaceIConnectable
- Specified by:
getConnections
in interfaceIConnectable.Jsii$Default
-
getProjectArn
The ARN of this Project.- Specified by:
getProjectArn
in interfaceIProject
-
getProjectName
The human-visible name of this Project.- Specified by:
getProjectName
in interfaceIProject
-
getRole
The IAM service Role of this Project.Undefined for imported Projects.
-
applyRemovalPolicy
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 interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
bindAsNotificationRuleSource
@Stability(Stable) @NotNull default NotificationRuleSourceConfig bindAsNotificationRuleSource(@NotNull software.constructs.Construct scope) Returns a source configuration for notification rule.- Specified by:
bindAsNotificationRuleSource
in interfaceINotificationRuleSource
- Specified by:
bindAsNotificationRuleSource
in interfaceINotificationRuleSource.Jsii$Default
- Parameters:
scope
- This parameter is required.
-
addToRolePolicy
- Specified by:
addToRolePolicy
in interfaceIProject
- Parameters:
policyStatement
- This parameter is required.
-
enableBatchBuilds
Enable batch builds.Returns an object contining the batch service role if batch builds could be enabled.
- Specified by:
enableBatchBuilds
in interfaceIProject
-
metric
@Stability(Stable) @NotNull default Metric metric(@NotNull String metricName, @Nullable MetricOptions props) -
metricBuilds
Measures the number of builds triggered.Units: Count
Valid CloudWatch statistics: Sum
Default: sum over 5 minutes
- Specified by:
metricBuilds
in interfaceIProject
- Parameters:
props
-
-
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 interfaceIProject
- Parameters:
props
-
-
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 interfaceIProject
- Parameters:
props
-
-
metricSucceededBuilds
Measures the number of successful builds.Units: Count
Valid CloudWatch statistics: Sum
Default: sum over 5 minutes
- Specified by:
metricSucceededBuilds
in interfaceIProject
- Parameters:
props
-
-
notifyOn
@Stability(Stable) @NotNull default 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 toonEvent
API.You can also use the methods
notifyOnBuildSucceeded
andnotifyOnBuildFailed
to define rules for these specific event emitted.- Specified by:
notifyOn
in interfaceIProject
- 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 default 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 interfaceIProject
- Parameters:
id
- This parameter is required.target
- This parameter is required.options
-
-
notifyOnBuildSucceeded
@Stability(Stable) @NotNull default 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 interfaceIProject
- Parameters:
id
- This parameter is required.target
- This parameter is required.options
-
-
onBuildFailed
@Stability(Stable) @NotNull default Rule onBuildFailed(@NotNull String id, @Nullable OnEventOptions options) Defines an event rule which triggers when a build fails.- Specified by:
onBuildFailed
in interfaceIProject
- Parameters:
id
- This parameter is required.options
-
-
onBuildStarted
@Stability(Stable) @NotNull default Rule onBuildStarted(@NotNull String id, @Nullable OnEventOptions options) Defines an event rule which triggers when a build starts.- Specified by:
onBuildStarted
in interfaceIProject
- Parameters:
id
- This parameter is required.options
-
-
onBuildSucceeded
@Stability(Stable) @NotNull default Rule onBuildSucceeded(@NotNull String id, @Nullable OnEventOptions options) Defines an event rule which triggers when a build completes successfully.- Specified by:
onBuildSucceeded
in interfaceIProject
- Parameters:
id
- This parameter is required.options
-
-
onEvent
@Stability(Stable) @NotNull default Rule onEvent(@NotNull String id, @Nullable OnEventOptions options) Defines a CloudWatch event rule triggered when something happens with this project. -
onPhaseChange
@Stability(Stable) @NotNull default 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 interfaceIProject
- Parameters:
id
- This parameter is required.options
-- See Also:
-
onStateChange
@Stability(Stable) @NotNull default 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
andonBuildSucceeded
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 interfaceIProject
- Parameters:
id
- This parameter is required.options
-- See Also:
-