Interface IAction
A Pipeline Action.
Namespace: Amazon.CDK.AWS.CodePipeline
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IAction
Syntax (vb)
Public Interface IAction
Remarks
If you want to implement this interface,
consider extending the Action
class,
which contains some common logic.
Synopsis
Properties
ActionProperties | The simple properties of the Action, like its Owner, name, etc. |
Methods
Bind(Construct, IStage, IActionBindOptions) | The callback invoked when this Action is added to a Pipeline. |
OnStateChange(String, IRuleTarget, IRuleProps) | Creates an Event that will be triggered whenever the state of this Action changes. |
Properties
ActionProperties
The simple properties of the Action, like its Owner, name, etc.
IActionProperties ActionProperties { get; }
Property Value
Remarks
Note that this accessor will be called before the bind
callback.
Methods
Bind(Construct, IStage, IActionBindOptions)
The callback invoked when this Action is added to a Pipeline.
IActionConfig Bind(Construct scope, IStage stage, IActionBindOptions options)
Parameters
- scope Constructs.Construct
the Construct tree scope the Action can use if it needs to create any resources.
- stage IStage
the
IStage
this Action is being added to.- options IActionBindOptions
additional options the Action can use, like the artifact Bucket of the pipeline it's being added to.
Returns
OnStateChange(String, IRuleTarget, IRuleProps)
Creates an Event that will be triggered whenever the state of this Action changes.
Rule OnStateChange(string name, IRuleTarget target = null, IRuleProps options = null)
Parameters
- name System.String
the name to use for the new Event.
- target IRuleTarget
the optional target for the Event.
- options IRuleProps
additional options that can be used to customize the created Event.
Returns