software.amazon.awscdk.services.codepipeline

Interface IPipeline

All Superinterfaces:

IConstruct, IDependable, INotificationRuleSource, IResource

All Known Subinterfaces:

IPipeline.Jsii$Default

All Known Implementing Classes:

IPipeline.Jsii$Proxy, Pipeline

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:41.889Z")
public interface IPipeline
extends IResource, INotificationRuleSource

The abstract view of an AWS CodePipeline as required and used by Actions.

It extends {@link events.IRuleTarget}, so this interface can be used as a Target for CloudWatch Events.

Nested Class Summary

Nested Classes

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.

Method Summary

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.

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.services.codestarnotifications.INotificationRuleSource

bindAsNotificationRuleSource

Method Detail

getPipelineArn

java.lang.String getPipelineArn()

The ARN of the Pipeline.

getPipelineName

java.lang.String getPipelineName()

The name of the Pipeline.

notifyOn

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.

You can also use the methods notifyOnExecutionStateChange, notifyOnAnyStageStateChange, notifyOnAnyActionStateChange and notifyOnAnyManualApprovalStateChange to define rules for these specific event emitted.

Parameters:

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.

Returns:

CodeStar notification rule associated with this build project.

notifyOnAnyActionStateChange

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.

Parameters:

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.

See Also:

https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline

notifyOnAnyActionStateChange

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.

Parameters:

id - Identifier for this notification handler. This parameter is required.

target - The target to register for the CodeStar Notifications destination. This parameter is required.

See Also:

https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline

notifyOnAnyManualApprovalStateChange

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.

Parameters:

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.

See Also:

https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline

notifyOnAnyManualApprovalStateChange

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.

Parameters:

id - Identifier for this notification handler. This parameter is required.

target - The target to register for the CodeStar Notifications destination. This parameter is required.

See Also:

https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline

notifyOnAnyStageStateChange

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.

Parameters:

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.

See Also:

https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline

notifyOnAnyStageStateChange

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.

Parameters:

id - Identifier for this notification handler. This parameter is required.

target - The target to register for the CodeStar Notifications destination. This parameter is required.

See Also:

https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline

notifyOnExecutionStateChange

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.

Parameters:

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.

See Also:

https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline

notifyOnExecutionStateChange

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.

Parameters:

id - Identifier for this notification handler. This parameter is required.

target - The target to register for the CodeStar Notifications destination. This parameter is required.

See Also:

https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-pipeline

onEvent

Rule onEvent(java.lang.String id,
             OnEventOptions options)

Define an event rule triggered by this CodePipeline.

Parameters:

id - Identifier for this event handler. This parameter is required.

options - Additional options to pass to the event rule.

onEvent

Rule onEvent(java.lang.String id)

Define an event rule triggered by this CodePipeline.

Parameters:

id - Identifier for this event handler. This parameter is required.

onStateChange

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.

Parameters:

id - Identifier for this event handler. This parameter is required.

options - Additional options to pass to the event rule.

onStateChange

Rule onStateChange(java.lang.String id)

Define an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.

Parameters:

id - Identifier for this event handler. This parameter is required.