Package software.amazon.awscdk.services.codepipeline

Class Action

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.codepipeline.Action

All Implemented Interfaces:

IAction, software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

Action

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:37.861Z")
@Stability(Stable)
public abstract class Action
extends software.amazon.jsii.JsiiObject
implements IAction

Low-level class for generic CodePipeline Actions implementing the IAction interface.

Contains some common logic that can be re-used by all IAction implementations. If you're writing your own Action class, feel free to extend this class.

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.IAction

IAction.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Action()
protected	Action(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Action(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
ActionConfig	bind(Construct scope, IStage stage, ActionBindOptions options)	The callback invoked when this Action is added to a Pipeline.
protected abstract ActionConfig	bound(Construct scope, IStage stage, ActionBindOptions options)	This is a renamed version of the IAction.bind method.
ActionProperties	getActionProperties()	The simple properties of the Action, like its Owner, name, etc.
protected abstract ActionProperties	getProvidedActionProperties()	This is a renamed version of the IAction.actionProperties property.
Rule	onStateChange(String name)	Creates an Event that will be triggered whenever the state of this Action changes.
Rule	onStateChange(String name, IRuleTarget target)	Creates an Event that will be triggered whenever the state of this Action changes.
Rule	onStateChange(String name, IRuleTarget target, RuleProps options)	Creates an Event that will be triggered whenever the state of this Action changes.
protected String	variableExpression(String variableName)

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 Details

Action

protected Action(software.amazon.jsii.JsiiObjectRef objRef)

Action

protected Action(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Action

@Stability(Stable)
protected Action()

Method Details

bind

@Stability(Stable)
@NotNull
public ActionConfig bind(@NotNull
 Construct scope,
 @NotNull
 IStage stage,
 @NotNull
 ActionBindOptions options)

The callback invoked when this Action is added to a Pipeline.

Specified by:

bind in interface IAction

Parameters:

scope - This parameter is required.

stage - This parameter is required.

options - This parameter is required.

bound

@Stability(Stable)
@NotNull
protected abstract ActionConfig bound(@NotNull
 Construct scope,
 @NotNull
 IStage stage,
 @NotNull
 ActionBindOptions options)

This is a renamed version of the IAction.bind method.

Parameters:

scope - This parameter is required.

stage - This parameter is required.

options - This parameter is required.

onStateChange

@Stability(Stable)
@NotNull
public Rule onStateChange(@NotNull
 String name,
 @Nullable
 IRuleTarget target,
 @Nullable
 RuleProps options)

Creates an Event that will be triggered whenever the state of this Action changes.

Specified by:

onStateChange in interface IAction

Parameters:

name - This parameter is required.

target -

options -

onStateChange

@Stability(Stable)
@NotNull
public Rule onStateChange(@NotNull
 String name,
 @Nullable
 IRuleTarget target)

Creates an Event that will be triggered whenever the state of this Action changes.

Specified by:

onStateChange in interface IAction

Parameters:

name - This parameter is required.

target -

onStateChange

@Stability(Stable)
@NotNull
public Rule onStateChange(@NotNull
 String name)

Creates an Event that will be triggered whenever the state of this Action changes.

Specified by:

onStateChange in interface IAction

Parameters:

name - This parameter is required.

variableExpression

@Stability(Stable)
@NotNull
protected String variableExpression(@NotNull
 String variableName)

Parameters:

variableName - This parameter is required.

getActionProperties

@Stability(Stable)
@NotNull
public ActionProperties getActionProperties()

The simple properties of the Action, like its Owner, name, etc.

Note that this accessor will be called before the bind(software.amazon.awscdk.core.Construct,software.amazon.awscdk.services.codepipeline.IStage,software.amazon.awscdk.services.codepipeline.ActionBindOptions) callback.

Specified by:

getActionProperties in interface IAction

getProvidedActionProperties

@Stability(Stable)
@NotNull
protected abstract ActionProperties getProvidedActionProperties()

This is a renamed version of the IAction.actionProperties property.