software.amazon.awscdk.services.codepipeline

Interface IPipeline

All Superinterfaces:

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

All Known Subinterfaces:

IPipeline.Jsii$Default

All Known Implementing Classes:

IPipeline.Jsii$Proxy, Pipeline

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:56.608Z")
 @Stability(value=Experimental)
public interface IPipeline
extends software.amazon.jsii.JsiiSerializable, IResource

(experimental) 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() (experimental) The ARN of the Pipeline.
String	getPipelineName() (experimental) The name of the Pipeline.
Rule	onEvent(String id) (experimental) Define an event rule triggered by this CodePipeline.
Rule	onEvent(String id, OnEventOptions options) (experimental) Define an event rule triggered by this CodePipeline.
Rule	onStateChange(String id) (experimental) Define an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.
Rule	onStateChange(String id, OnEventOptions options) (experimental) Define an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.

Methods inherited from interface software.amazon.awscdk.IResource

getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPipelineArn

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

(experimental) The ARN of the Pipeline.

getPipelineName

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

(experimental) The name of the Pipeline.

onEvent

@Stability(value=Experimental)
 @NotNull
Rule onEvent(@NotNull
                                                      String id,
                                                      @Nullable
                                                      OnEventOptions options)

(experimental) 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=Experimental)
 @NotNull
Rule onEvent(@NotNull
                                                      String id)

(experimental) Define an event rule triggered by this CodePipeline.

Parameters:

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

onStateChange

@Stability(value=Experimental)
 @NotNull
Rule onStateChange(@NotNull
                                                            String id,
                                                            @Nullable
                                                            OnEventOptions options)

(experimental) 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=Experimental)
 @NotNull
Rule onStateChange(@NotNull
                                                            String id)

(experimental) 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.