Class Action

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

Inheritance

object

Action

Action

Implements

IAction

Namespace: Amazon.CDK.AWS.CodePipeline

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public abstract class Action : DeputyBase, IAction

Syntax (vb)

Public MustInherit Class Action Inherits DeputyBase Implements IAction

Remarks

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.

Synopsis

Constructors

Action()

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

Properties

ActionProperties	The simple properties of the Action, like its Owner, name, etc.
ProvidedActionProperties	This is a renamed version of the IAction.actionProperties property.

Methods

Bind(Construct, IStage, IActionBindOptions)	The callback invoked when this Action is added to a Pipeline.
Bound(Construct, IStage, IActionBindOptions)	This is a renamed version of the IAction.bind method.
OnStateChange(string, IRuleTarget?, IRuleProps?)	Creates an Event that will be triggered whenever the state of this Action changes.
VariableExpression(string)	Low-level class for generic CodePipeline Actions implementing the IAction interface.

Constructors

Action()

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

protected Action()

Remarks

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.

Properties

ActionProperties

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

public virtual IActionProperties ActionProperties { get; }

Property Value

IActionProperties

Remarks

Note that this accessor will be called before the bind callback.

ProvidedActionProperties

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

protected abstract IActionProperties ProvidedActionProperties { get; }

Property Value

IActionProperties

Remarks

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.

Methods

Bind(Construct, IStage, IActionBindOptions)

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

public virtual IActionConfig Bind(Construct scope, IStage stage, IActionBindOptions options)

Parameters

scope Construct

stage IStage

options IActionBindOptions

Returns

IActionConfig

Remarks

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.

Bound(Construct, IStage, IActionBindOptions)

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

protected abstract IActionConfig Bound(Construct scope, IStage stage, IActionBindOptions options)

Parameters

scope Construct

stage IStage

options IActionBindOptions

Returns

IActionConfig

Remarks

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.

OnStateChange(string, IRuleTarget?, IRuleProps?)

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

public virtual Rule OnStateChange(string name, IRuleTarget? target = null, IRuleProps? options = null)

Parameters

name string

target IRuleTarget

options IRuleProps

Returns

Rule

Remarks

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.

VariableExpression(string)

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

protected virtual string VariableExpression(string variableName)

Parameters

variableName string

Returns

string

Remarks

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.

Implements

IAction