@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:41.889Z") public interface IPipeline extends IResource, INotificationRuleSource
It extends {@link events.IRuleTarget}, so this interface can be used as a Target for CloudWatch Events.
Modifier and Type | Interface and Description |
---|---|
static interface |
IPipeline.Jsii$Default
Internal default implementation for
IPipeline . |
static class |
IPipeline.Jsii$Proxy
A proxy class which represents a concrete javascript instance of this type.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getPipelineArn()
The ARN of the Pipeline.
|
java.lang.String |
getPipelineName()
The name of the Pipeline.
|
INotificationRule |
notifyOn(java.lang.String id,
INotificationRuleTarget target,
PipelineNotifyOnOptions options)
Defines a CodeStar notification rule triggered when the pipeline events emitted by you specified, it very similar to `onEvent` API.
|
INotificationRule |
notifyOnAnyActionStateChange(java.lang.String id,
INotificationRuleTarget target)
Define an notification rule triggered by the set of the "Action execution" events emitted from this pipeline.
|
INotificationRule |
notifyOnAnyActionStateChange(java.lang.String id,
INotificationRuleTarget target,
NotificationRuleOptions options)
Define an notification rule triggered by the set of the "Action execution" events emitted from this pipeline.
|
INotificationRule |
notifyOnAnyManualApprovalStateChange(java.lang.String id,
INotificationRuleTarget target)
Define an notification rule triggered by the set of the "Manual approval" events emitted from this pipeline.
|
INotificationRule |
notifyOnAnyManualApprovalStateChange(java.lang.String id,
INotificationRuleTarget target,
NotificationRuleOptions options)
Define an notification rule triggered by the set of the "Manual approval" events emitted from this pipeline.
|
INotificationRule |
notifyOnAnyStageStateChange(java.lang.String id,
INotificationRuleTarget target)
Define an notification rule triggered by the set of the "Stage execution" events emitted from this pipeline.
|
INotificationRule |
notifyOnAnyStageStateChange(java.lang.String id,
INotificationRuleTarget target,
NotificationRuleOptions options)
Define an notification rule triggered by the set of the "Stage execution" events emitted from this pipeline.
|
INotificationRule |
notifyOnExecutionStateChange(java.lang.String id,
INotificationRuleTarget target)
Define an notification rule triggered by the set of the "Pipeline execution" events emitted from this pipeline.
|
INotificationRule |
notifyOnExecutionStateChange(java.lang.String id,
INotificationRuleTarget target,
NotificationRuleOptions options)
Define an notification rule triggered by the set of the "Pipeline execution" events emitted from this pipeline.
|
Rule |
onEvent(java.lang.String id)
Define an event rule triggered by this CodePipeline.
|
Rule |
onEvent(java.lang.String id,
OnEventOptions options)
Define an event rule triggered by this CodePipeline.
|
Rule |
onStateChange(java.lang.String id)
Define an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.
|
Rule |
onStateChange(java.lang.String id,
OnEventOptions options)
Define an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.
|
applyRemovalPolicy, getEnv, getStack
getNode
bindAsNotificationRuleSource
java.lang.String getPipelineArn()
java.lang.String getPipelineName()
INotificationRule notifyOn(java.lang.String id, INotificationRuleTarget target, PipelineNotifyOnOptions options)
You can also use the methods notifyOnExecutionStateChange
, notifyOnAnyStageStateChange
,
notifyOnAnyActionStateChange
and notifyOnAnyManualApprovalStateChange
to define rules for these specific event emitted.
id
- The id of the CodeStar notification rule. This parameter is required.target
- The target to register for the CodeStar Notifications destination. This parameter is required.options
- Customization options for CodeStar notification rule. This parameter is required.INotificationRule notifyOnAnyActionStateChange(java.lang.String id, INotificationRuleTarget target, NotificationRuleOptions options)
id
- Identifier for this notification handler. This parameter is required.target
- The target to register for the CodeStar Notifications destination. This parameter is required.options
- Additional options to pass to the notification rule.INotificationRule notifyOnAnyActionStateChange(java.lang.String id, INotificationRuleTarget target)
id
- Identifier for this notification handler. This parameter is required.target
- The target to register for the CodeStar Notifications destination. This parameter is required.INotificationRule notifyOnAnyManualApprovalStateChange(java.lang.String id, INotificationRuleTarget target, NotificationRuleOptions options)
id
- Identifier for this notification handler. This parameter is required.target
- The target to register for the CodeStar Notifications destination. This parameter is required.options
- Additional options to pass to the notification rule.INotificationRule notifyOnAnyManualApprovalStateChange(java.lang.String id, INotificationRuleTarget target)
id
- Identifier for this notification handler. This parameter is required.target
- The target to register for the CodeStar Notifications destination. This parameter is required.INotificationRule notifyOnAnyStageStateChange(java.lang.String id, INotificationRuleTarget target, NotificationRuleOptions options)
id
- Identifier for this notification handler. This parameter is required.target
- The target to register for the CodeStar Notifications destination. This parameter is required.options
- Additional options to pass to the notification rule.INotificationRule notifyOnAnyStageStateChange(java.lang.String id, INotificationRuleTarget target)
id
- Identifier for this notification handler. This parameter is required.target
- The target to register for the CodeStar Notifications destination. This parameter is required.INotificationRule notifyOnExecutionStateChange(java.lang.String id, INotificationRuleTarget target, NotificationRuleOptions options)
id
- Identifier for this notification handler. This parameter is required.target
- The target to register for the CodeStar Notifications destination. This parameter is required.options
- Additional options to pass to the notification rule.INotificationRule notifyOnExecutionStateChange(java.lang.String id, INotificationRuleTarget target)
id
- Identifier for this notification handler. This parameter is required.target
- The target to register for the CodeStar Notifications destination. This parameter is required.Rule onEvent(java.lang.String id, OnEventOptions options)
id
- Identifier for this event handler. This parameter is required.options
- Additional options to pass to the event rule.Rule onEvent(java.lang.String id)
id
- Identifier for this event handler. This parameter is required.Rule onStateChange(java.lang.String id, OnEventOptions options)
id
- Identifier for this event handler. This parameter is required.options
- Additional options to pass to the event rule.Rule onStateChange(java.lang.String id)
id
- Identifier for this event handler. This parameter is required.