Class Action
Low-level class for generic CodePipeline Actions implementing the IAction
interface.
Implements
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() | |
Action(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
Action(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
ActionProperties | The simple properties of the Action, like its Owner, name, etc. |
ProvidedActionProperties | This is a renamed version of the |
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 |
OnStateChange(String, IRuleTarget, IRuleProps) | Creates an Event that will be triggered whenever the state of this Action changes. |
VariableExpression(String) |
Constructors
Action()
protected Action()
Action(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected Action(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
Action(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected Action(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
ActionProperties
The simple properties of the Action, like its Owner, name, etc.
public virtual IActionProperties ActionProperties { get; }
Property Value
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
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 Constructs.Construct
- stage IStage
- options IActionBindOptions
Returns
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 Constructs.Construct
- stage IStage
- options IActionBindOptions
Returns
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 System.String
- target IRuleTarget
- options IRuleProps
Returns
VariableExpression(String)
protected virtual string VariableExpression(string variableName)
Parameters
- variableName System.String
Returns
System.String