IPipeline.Jsii$Proxy (software.amazon.awscdk:codepipeline 1.183.0 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.codepipeline.IPipeline.Jsii$Proxy

All Implemented Interfaces:

IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default, IPipeline, IPipeline.Jsii$Default, INotificationRuleSource, INotificationRuleSource.Jsii$Default, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default

Enclosing interface:

IPipeline
```
@Internal
public static final class IPipeline.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IPipeline.Jsii$Default
```
A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary
- Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
  software.amazon.jsii.JsiiObject.InitializationMode
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codepipeline.IPipeline
  IPipeline.Jsii$Default, IPipeline.Jsii$Proxy

Constructor Summary

Constructors
Modifier Constructor and Description

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructors
Modifier	Constructor and Description
`protected`	`Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyRemovalPolicy(RemovalPolicy policy)` Apply the given removal policy to this resource.
`NotificationRuleSourceConfig`	`bindAsNotificationRuleSource(software.constructs.Construct scope)` Returns a source configuration for notification rule.
`ResourceEnvironment`	`getEnv()` The environment this resource belongs to.
`ConstructNode`	`getNode()` The construct tree node for this construct.
`String`	`getPipelineArn()` The ARN of the Pipeline.
`String`	`getPipelineName()` The name of the Pipeline.
`Stack`	`getStack()` The stack in which this resource is defined.
`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 class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Detail

getNode
```
@Stability(value=Stable)
 @NotNull
public final ConstructNode getNode()
```
The construct tree node for this construct.

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface IPipeline.Jsii$Default

getEnv
```
@Stability(value=Stable)
 @NotNull
public final ResourceEnvironment getEnv()
```
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

Specified by:

getEnv in interface IPipeline.Jsii$Default

getStack
```
@Stability(value=Stable)
 @NotNull
public final Stack getStack()
```
The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface IPipeline.Jsii$Default

getPipelineArn
```
@Stability(value=Stable)
 @NotNull
public final String getPipelineArn()
```
The ARN of the Pipeline.

Specified by:

getPipelineArn in interface IPipeline

Specified by:

getPipelineArn in interface IPipeline.Jsii$Default

getPipelineName
```
@Stability(value=Stable)
 @NotNull
public final String getPipelineName()
```
The name of the Pipeline.

Specified by:

getPipelineName in interface IPipeline

Specified by:

getPipelineName in interface IPipeline.Jsii$Default

applyRemovalPolicy
```
@Stability(value=Stable)
public final void applyRemovalPolicy(@NotNull
                                                              RemovalPolicy policy)
```
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Specified by:

applyRemovalPolicy in interface IPipeline.Jsii$Default

Parameters:

policy - This parameter is required.

bindAsNotificationRuleSource
```
@Stability(value=Stable)
 @NotNull
public final NotificationRuleSourceConfig bindAsNotificationRuleSource(@NotNull
                                                                                                          software.constructs.Construct scope)
```
Returns a source configuration for notification rule.

Specified by:

bindAsNotificationRuleSource in interface IPipeline.Jsii$Default

Specified by:

bindAsNotificationRuleSource in interface INotificationRuleSource

Specified by:

bindAsNotificationRuleSource in interface INotificationRuleSource.Jsii$Default

Parameters:

scope - This parameter is required.

notifyOn

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

Specified by:: notifyOn in interface IPipeline
Specified by:: notifyOn in interface IPipeline.Jsii$Default
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
public final 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.

Specified by:: notifyOnAnyActionStateChange in interface IPipeline
Specified by:: notifyOnAnyActionStateChange in interface IPipeline.Jsii$Default
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
public final 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.

Specified by:: notifyOnAnyActionStateChange in interface IPipeline
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
public final 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.

Specified by:: notifyOnAnyManualApprovalStateChange in interface IPipeline
Specified by:: notifyOnAnyManualApprovalStateChange in interface IPipeline.Jsii$Default
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
public final 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.

Specified by:: notifyOnAnyManualApprovalStateChange in interface IPipeline
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
public final 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.

Specified by:: notifyOnAnyStageStateChange in interface IPipeline
Specified by:: notifyOnAnyStageStateChange in interface IPipeline.Jsii$Default
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
public final 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.

Specified by:: notifyOnAnyStageStateChange in interface IPipeline
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
public final 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.

Specified by:: notifyOnExecutionStateChange in interface IPipeline
Specified by:: notifyOnExecutionStateChange in interface IPipeline.Jsii$Default
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
public final 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.

Specified by:: notifyOnExecutionStateChange in interface IPipeline
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
public final Rule onEvent(@NotNull
                                                             String id,
                                                             @Nullable
                                                             OnEventOptions options)

Define an event rule triggered by this CodePipeline.

Specified by:: onEvent in interface IPipeline
Specified by:: onEvent in interface IPipeline.Jsii$Default
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
public final Rule onEvent(@NotNull
                                                             String id)

Define an event rule triggered by this CodePipeline.

Specified by:: onEvent in interface IPipeline
Parameters:: id - Identifier for this event handler. This parameter is required.

onStateChange

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

Specified by:: onStateChange in interface IPipeline
Specified by:: onStateChange in interface IPipeline.Jsii$Default
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
public final Rule onStateChange(@NotNull
                                                                   String id)
```
Define an event rule triggered by the "CodePipeline Pipeline Execution State Change" event emitted from this pipeline.

Specified by:

onStateChange in interface IPipeline

Parameters:

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

Class IPipeline.Jsii$Proxy

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codepipeline.IPipeline

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Constructor Detail

Jsii$Proxy

Method Detail

getNode

getEnv

getStack

getPipelineArn

getPipelineName

applyRemovalPolicy

bindAsNotificationRuleSource

notifyOn

notifyOnAnyActionStateChange

notifyOnAnyActionStateChange

notifyOnAnyManualApprovalStateChange

notifyOnAnyManualApprovalStateChange

notifyOnAnyStageStateChange

notifyOnAnyStageStateChange

notifyOnExecutionStateChange

notifyOnExecutionStateChange

onEvent

onEvent

onStateChange

onStateChange