software.amazon.awscdk.services.codepipeline

Interface IPipeline

All Superinterfaces:

software.constructs.IConstruct, IDependable, INotificationRuleSource, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IPipeline.Jsii$Default

All Known Implementing Classes:

IPipeline.Jsii$Proxy, Pipeline

@Generated(value="jsii-pacmak/1.72.0 (build 4b8828b)",
           date="2022-12-14T20:30:48.393Z")
 @Stability(value=Stable)
public interface IPipeline
extends software.amazon.jsii.JsiiSerializable, 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
String	getPipelineArn() The ARN of the Pipeline.
String	getPipelineName() The name of the Pipeline.
INotificationRule	notifyOn(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(String id, INotificationRuleTarget target) Define an notification rule triggered by the set of the "Action execution" events emitted from this pipeline.
INotificationRule	notifyOnAnyActionStateChange(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(String id, INotificationRuleTarget target) Define an notification rule triggered by the set of the "Manual approval" events emitted from this pipeline.
INotificationRule	notifyOnAnyManualApprovalStateChange(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(String id, INotificationRuleTarget target) Define an notification rule triggered by the set of the "Stage execution" events emitted from this pipeline.
INotificationRule	notifyOnAnyStageStateChange(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(String id, INotificationRuleTarget target) Define an notification rule triggered by the set of the "Pipeline execution" events emitted from this pipeline.
INotificationRule	notifyOnExecutionStateChange(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(String id) Define an event rule triggered by this CodePipeline.
Rule	onEvent(String id, OnEventOptions options) Define an event rule triggered by this CodePipeline.
Rule	onStateChange(String id) Define an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.
Rule	onStateChange(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.jsii.JsiiSerializable

$jsii$toJson

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

bindAsNotificationRuleSource

Method Detail

getPipelineArn

@Stability(value=Stable)
 @NotNull
String getPipelineArn()

The ARN of the Pipeline.

getPipelineName

@Stability(value=Stable)
 @NotNull
String getPipelineName()

The name of the Pipeline.

notifyOn

@Stability(value=Stable)
 @NotNull
INotificationRule notifyOn(@NotNull
                                                              String id,
                                                              @NotNull
                                                              INotificationRuleTarget target,
                                                              @NotNull
                                                              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

@Stability(value=Stable)
 @NotNull
INotificationRule notifyOnAnyActionStateChange(@NotNull
                                                                                  String id,
                                                                                  @NotNull
                                                                                  INotificationRuleTarget target,
                                                                                  @Nullable
                                                                                  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

@Stability(value=Stable)
 @NotNull
INotificationRule notifyOnAnyActionStateChange(@NotNull
                                                                                  String id,
                                                                                  @NotNull
                                                                                  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

@Stability(value=Stable)
 @NotNull
INotificationRule notifyOnAnyManualApprovalStateChange(@NotNull
                                                                                          String id,
                                                                                          @NotNull
                                                                                          INotificationRuleTarget target,
                                                                                          @Nullable
                                                                                          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

@Stability(value=Stable)
 @NotNull
INotificationRule notifyOnAnyManualApprovalStateChange(@NotNull
                                                                                          String id,
                                                                                          @NotNull
                                                                                          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

@Stability(value=Stable)
 @NotNull
INotificationRule notifyOnAnyStageStateChange(@NotNull
                                                                                 String id,
                                                                                 @NotNull
                                                                                 INotificationRuleTarget target,
                                                                                 @Nullable
                                                                                 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

@Stability(value=Stable)
 @NotNull
INotificationRule notifyOnAnyStageStateChange(@NotNull
                                                                                 String id,
                                                                                 @NotNull
                                                                                 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

@Stability(value=Stable)
 @NotNull
INotificationRule notifyOnExecutionStateChange(@NotNull
                                                                                  String id,
                                                                                  @NotNull
                                                                                  INotificationRuleTarget target,
                                                                                  @Nullable
                                                                                  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

@Stability(value=Stable)
 @NotNull
INotificationRule notifyOnExecutionStateChange(@NotNull
                                                                                  String id,
                                                                                  @NotNull
                                                                                  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

@Stability(value=Stable)
 @NotNull
Rule onEvent(@NotNull
                                                String id,
                                                @Nullable
                                                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

@Stability(value=Stable)
 @NotNull
Rule onEvent(@NotNull
                                                String id)

Define an event rule triggered by this CodePipeline.

Parameters:

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

onStateChange

@Stability(value=Stable)
 @NotNull
Rule onStateChange(@NotNull
                                                      String id,
                                                      @Nullable
                                                      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

@Stability(value=Stable)
 @NotNull
Rule onStateChange(@NotNull
                                                      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.