public static final class IProject.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements IProject.Jsii$Default
IProject.Jsii$Default, IProject.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) |
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.
|
public final ConstructNode getNode()
getNode
in interface IConstruct
getNode
in interface IConstruct.Jsii$Default
getNode
in interface IResource.Jsii$Default
getNode
in interface IProject.Jsii$Default
public final ResourceEnvironment getEnv()
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.
getEnv
in interface IResource
getEnv
in interface IResource.Jsii$Default
getEnv
in interface IProject.Jsii$Default
public final Stack getStack()
getStack
in interface IResource
getStack
in interface IResource.Jsii$Default
getStack
in interface IProject.Jsii$Default
public final IPrincipal getGrantPrincipal()
getGrantPrincipal
in interface IProject.Jsii$Default
getGrantPrincipal
in interface IGrantable
getGrantPrincipal
in interface IGrantable.Jsii$Default
public final Connections getConnections()
getConnections
in interface IProject.Jsii$Default
getConnections
in interface IConnectable
getConnections
in interface IConnectable.Jsii$Default
public final java.lang.String getProjectArn()
getProjectArn
in interface IProject
getProjectArn
in interface IProject.Jsii$Default
public final java.lang.String getProjectName()
getProjectName
in interface IProject
getProjectName
in interface IProject.Jsii$Default
public final IRole getRole()
Undefined for imported Projects.
getRole
in interface IProject
getRole
in interface IProject.Jsii$Default
public final void applyRemovalPolicy(RemovalPolicy policy)
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
).
applyRemovalPolicy
in interface IResource
applyRemovalPolicy
in interface IResource.Jsii$Default
applyRemovalPolicy
in interface IProject.Jsii$Default
policy
- This parameter is required.public final NotificationRuleSourceConfig bindAsNotificationRuleSource(software.constructs.Construct scope)
bindAsNotificationRuleSource
in interface IProject.Jsii$Default
bindAsNotificationRuleSource
in interface INotificationRuleSource
bindAsNotificationRuleSource
in interface INotificationRuleSource.Jsii$Default
scope
- This parameter is required.public final void addToRolePolicy(PolicyStatement policyStatement)
addToRolePolicy
in interface IProject
addToRolePolicy
in interface IProject.Jsii$Default
policyStatement
- This parameter is required.public final BatchBuildConfig enableBatchBuilds()
Returns an object contining the batch service role if batch builds could be enabled.
enableBatchBuilds
in interface IProject
enableBatchBuilds
in interface IProject.Jsii$Default
public final Metric metric(java.lang.String metricName, MetricOptions props)
metric
in interface IProject
metric
in interface IProject.Jsii$Default
metricName
- The name of the metric. This parameter is required.props
- Customization properties.public final Metric metric(java.lang.String metricName)
public final Metric metricBuilds(MetricOptions props)
Units: Count
Valid CloudWatch statistics: Sum
Default: sum over 5 minutes
metricBuilds
in interface IProject
metricBuilds
in interface IProject.Jsii$Default
props
- public final Metric metricBuilds()
Units: Count
Valid CloudWatch statistics: Sum
Default: sum over 5 minutes
metricBuilds
in interface IProject
public final Metric metricDuration(MetricOptions props)
Units: Seconds
Valid CloudWatch statistics: Average (recommended), Maximum, Minimum
Default: average over 5 minutes
metricDuration
in interface IProject
metricDuration
in interface IProject.Jsii$Default
props
- public final Metric metricDuration()
Units: Seconds
Valid CloudWatch statistics: Average (recommended), Maximum, Minimum
Default: average over 5 minutes
metricDuration
in interface IProject
public final Metric metricFailedBuilds(MetricOptions props)
Units: Count
Valid CloudWatch statistics: Sum
Default: sum over 5 minutes
metricFailedBuilds
in interface IProject
metricFailedBuilds
in interface IProject.Jsii$Default
props
- public final Metric metricFailedBuilds()
Units: Count
Valid CloudWatch statistics: Sum
Default: sum over 5 minutes
metricFailedBuilds
in interface IProject
public final Metric metricSucceededBuilds(MetricOptions props)
Units: Count
Valid CloudWatch statistics: Sum
Default: sum over 5 minutes
metricSucceededBuilds
in interface IProject
metricSucceededBuilds
in interface IProject.Jsii$Default
props
- public final Metric metricSucceededBuilds()
Units: Count
Valid CloudWatch statistics: Sum
Default: sum over 5 minutes
metricSucceededBuilds
in interface IProject
public final INotificationRule notifyOn(java.lang.String id, INotificationRuleTarget target, ProjectNotifyOnOptions options)
You can also use the methods notifyOnBuildSucceeded
and
notifyOnBuildFailed
to define rules for these specific event emitted.
notifyOn
in interface IProject
notifyOn
in interface IProject.Jsii$Default
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.public final INotificationRule notifyOnBuildFailed(java.lang.String id, INotificationRuleTarget target, NotificationRuleOptions options)
notifyOnBuildFailed
in interface IProject
notifyOnBuildFailed
in interface IProject.Jsii$Default
id
- This parameter is required.target
- This parameter is required.options
- public final INotificationRule notifyOnBuildFailed(java.lang.String id, INotificationRuleTarget target)
notifyOnBuildFailed
in interface IProject
id
- This parameter is required.target
- This parameter is required.public final INotificationRule notifyOnBuildSucceeded(java.lang.String id, INotificationRuleTarget target, NotificationRuleOptions options)
notifyOnBuildSucceeded
in interface IProject
notifyOnBuildSucceeded
in interface IProject.Jsii$Default
id
- This parameter is required.target
- This parameter is required.options
- public final INotificationRule notifyOnBuildSucceeded(java.lang.String id, INotificationRuleTarget target)
notifyOnBuildSucceeded
in interface IProject
id
- This parameter is required.target
- This parameter is required.public final Rule onBuildFailed(java.lang.String id, OnEventOptions options)
onBuildFailed
in interface IProject
onBuildFailed
in interface IProject.Jsii$Default
id
- This parameter is required.options
- public final Rule onBuildFailed(java.lang.String id)
onBuildFailed
in interface IProject
id
- This parameter is required.public final Rule onBuildStarted(java.lang.String id, OnEventOptions options)
onBuildStarted
in interface IProject
onBuildStarted
in interface IProject.Jsii$Default
id
- This parameter is required.options
- public final Rule onBuildStarted(java.lang.String id)
onBuildStarted
in interface IProject
id
- This parameter is required.public final Rule onBuildSucceeded(java.lang.String id, OnEventOptions options)
onBuildSucceeded
in interface IProject
onBuildSucceeded
in interface IProject.Jsii$Default
id
- This parameter is required.options
- public final Rule onBuildSucceeded(java.lang.String id)
onBuildSucceeded
in interface IProject
id
- This parameter is required.public final Rule onEvent(java.lang.String id, OnEventOptions options)
onEvent
in interface IProject
onEvent
in interface IProject.Jsii$Default
id
- This parameter is required.options
- public final Rule onEvent(java.lang.String id)
onEvent
in interface IProject
id
- This parameter is required.public final Rule onPhaseChange(java.lang.String id, OnEventOptions options)
onPhaseChange
in interface IProject
onPhaseChange
in interface IProject.Jsii$Default
id
- This parameter is required.options
- public final Rule onPhaseChange(java.lang.String id)
onPhaseChange
in interface IProject
id
- This parameter is required.public final Rule onStateChange(java.lang.String id, OnEventOptions options)
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.
onStateChange
in interface IProject
onStateChange
in interface IProject.Jsii$Default
id
- This parameter is required.options
- public final Rule onStateChange(java.lang.String id)
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.
onStateChange
in interface IProject
id
- This parameter is required.