Interface IAction

A Pipeline Action.

public interface IAction

Public Interface IAction

If you want to implement this interface, consider extending the Action class, which contains some common logic.

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

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.

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

IActionProperties ActionProperties { get; }

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

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

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

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

If you want to implement this interface, consider extending the Action class, which contains some common logic.

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

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

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

If you want to implement this interface, consider extending the Action class, which contains some common logic.