Interface IPipeline
The abstract view of an AWS CodePipeline as required and used by Actions.
Inherited Members
Namespace: Amazon.CDK.AWS.CodePipeline
Assembly: Amazon.CDK.AWS.CodePipeline.dll
Syntax (csharp)
public interface IPipeline : IResource, IConstruct, IDependable, INotificationRuleSource
Syntax (vb)
Public Interface IPipeline
Inherits IResource, IConstruct, IConstruct, IDependable, INotificationRuleSource
Remarks
It extends {@link events.IRuleTarget}, so this interface can be used as a Target for CloudWatch Events.
Synopsis
Properties
PipelineArn | The ARN of the Pipeline. |
PipelineName | The name of the Pipeline. |
Methods
NotifyOn(String, INotificationRuleTarget, IPipelineNotifyOnOptions) | Defines a CodeStar notification rule triggered when the pipeline events emitted by you specified, it very similar to |
NotifyOnAnyActionStateChange(String, INotificationRuleTarget, INotificationRuleOptions) | Define an notification rule triggered by the set of the "Action execution" events emitted from this pipeline. |
NotifyOnAnyManualApprovalStateChange(String, INotificationRuleTarget, INotificationRuleOptions) | Define an notification rule triggered by the set of the "Manual approval" events emitted from this pipeline. |
NotifyOnAnyStageStateChange(String, INotificationRuleTarget, INotificationRuleOptions) | Define an notification rule triggered by the set of the "Stage execution" events emitted from this pipeline. |
NotifyOnExecutionStateChange(String, INotificationRuleTarget, INotificationRuleOptions) | Define an notification rule triggered by the set of the "Pipeline execution" events emitted from this pipeline. |
OnEvent(String, IOnEventOptions) | Define an event rule triggered by this CodePipeline. |
OnStateChange(String, IOnEventOptions) | Define an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline. |
Properties
PipelineArn
The ARN of the Pipeline.
string PipelineArn { get; }
Property Value
System.String
Remarks
Attribute: true
PipelineName
The name of the Pipeline.
string PipelineName { get; }
Property Value
System.String
Remarks
Attribute: true
Methods
NotifyOn(String, INotificationRuleTarget, IPipelineNotifyOnOptions)
Defines a CodeStar notification rule triggered when the pipeline events emitted by you specified, it very similar to onEvent
API.
INotificationRule NotifyOn(string id, INotificationRuleTarget target, IPipelineNotifyOnOptions options)
Parameters
- id System.String
The id of the CodeStar notification rule.
- target INotificationRuleTarget
The target to register for the CodeStar Notifications destination.
- options IPipelineNotifyOnOptions
Customization options for CodeStar notification rule.
Returns
CodeStar notification rule associated with this build project.
Remarks
You can also use the methods notifyOnExecutionStateChange
, notifyOnAnyStageStateChange
,
notifyOnAnyActionStateChange
and notifyOnAnyManualApprovalStateChange
to define rules for these specific event emitted.
NotifyOnAnyActionStateChange(String, INotificationRuleTarget, INotificationRuleOptions)
Define an notification rule triggered by the set of the "Action execution" events emitted from this pipeline.
INotificationRule NotifyOnAnyActionStateChange(string id, INotificationRuleTarget target, INotificationRuleOptions options = null)
Parameters
- id System.String
Identifier for this notification handler.
- target INotificationRuleTarget
The target to register for the CodeStar Notifications destination.
- options INotificationRuleOptions
Additional options to pass to the notification rule.
Returns
Remarks
NotifyOnAnyManualApprovalStateChange(String, INotificationRuleTarget, INotificationRuleOptions)
Define an notification rule triggered by the set of the "Manual approval" events emitted from this pipeline.
INotificationRule NotifyOnAnyManualApprovalStateChange(string id, INotificationRuleTarget target, INotificationRuleOptions options = null)
Parameters
- id System.String
Identifier for this notification handler.
- target INotificationRuleTarget
The target to register for the CodeStar Notifications destination.
- options INotificationRuleOptions
Additional options to pass to the notification rule.
Returns
Remarks
NotifyOnAnyStageStateChange(String, INotificationRuleTarget, INotificationRuleOptions)
Define an notification rule triggered by the set of the "Stage execution" events emitted from this pipeline.
INotificationRule NotifyOnAnyStageStateChange(string id, INotificationRuleTarget target, INotificationRuleOptions options = null)
Parameters
- id System.String
Identifier for this notification handler.
- target INotificationRuleTarget
The target to register for the CodeStar Notifications destination.
- options INotificationRuleOptions
Additional options to pass to the notification rule.
Returns
Remarks
NotifyOnExecutionStateChange(String, INotificationRuleTarget, INotificationRuleOptions)
Define an notification rule triggered by the set of the "Pipeline execution" events emitted from this pipeline.
INotificationRule NotifyOnExecutionStateChange(string id, INotificationRuleTarget target, INotificationRuleOptions options = null)
Parameters
- id System.String
Identifier for this notification handler.
- target INotificationRuleTarget
The target to register for the CodeStar Notifications destination.
- options INotificationRuleOptions
Additional options to pass to the notification rule.
Returns
Remarks
OnEvent(String, IOnEventOptions)
Define an event rule triggered by this CodePipeline.
Rule OnEvent(string id, IOnEventOptions options = null)
Parameters
- id System.String
Identifier for this event handler.
- options IOnEventOptions
Additional options to pass to the event rule.
Returns
OnStateChange(String, IOnEventOptions)
Define an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.
Rule OnStateChange(string id, IOnEventOptions options = null)
Parameters
- id System.String
Identifier for this event handler.
- options IOnEventOptions
Additional options to pass to the event rule.
Returns