class Action

Language	Type name
.NET	Amazon.CDK.AWS.CodePipeline.Action
Java	software.amazon.awscdk.services.codepipeline.Action
Python	aws_cdk.aws_codepipeline.Action
TypeScript (source)	@aws-cdk/aws-codepipeline » Action

Implements IAction

Implemented by AlexaSkillDeployAction, CloudFormationCreateReplaceChangeSetAction, CloudFormationCreateUpdateStackAction, CloudFormationDeleteStackAction, CloudFormationDeployStackInstancesAction, CloudFormationDeployStackSetAction, CloudFormationExecuteChangeSetAction, CodeBuildAction, CodeCommitSourceAction, CodeDeployEcsDeployAction, CodeDeployServerDeployAction, CodeStarConnectionsSourceAction, EcrSourceAction, EcsDeployAction, GitHubSourceAction, JenkinsAction, LambdaInvokeAction, ManualApprovalAction, S3DeployAction, S3SourceAction, ServiceCatalogDeployActionBeta1, StepFunctionInvokeAction

Low-level class for generic CodePipeline Actions implementing the {@link IAction} interface.

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

Initializer

new Action()

Properties

Name	Type	Description
actionProperties	ActionProperties	The simple properties of the Action, like its Owner, name, etc.
providedActionProperties	ActionProperties	This is a renamed version of the {@link IAction.actionProperties} property.

---

actionProperties

Type: ActionProperties

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

Note that this accessor will be called before the {@link bind} callback.

---

providedActionProperties

Type: ActionProperties

This is a renamed version of the {@link IAction.actionProperties} property.

Methods

Name	Description
bind(scope, stage, options)	The callback invoked when this Action is added to a Pipeline.
onStateChange(name, target?, options?)	Creates an Event that will be triggered whenever the state of this Action changes.
protected bound(scope, stage, options)	This is a renamed version of the {@link IAction.bind} method.
protected variableExpression(variableName)

---

bind(scope, stage, options)

public bind(scope: Construct, stage: IStage, options: ActionBindOptions): ActionConfig

Parameters

• scope Construct
• stage IStage
• options ActionBindOptions

Returns

• ActionConfig

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

---

onStateChange(name, target?, options?)

public onStateChange(name: string, target?: IRuleTarget, options?: RuleProps): Rule

Parameters

• name string
• target IRuleTarget
• options RuleProps

Returns

• Rule

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

---

protected bound(scope, stage, options)

protected bound(scope: Construct, stage: IStage, options: ActionBindOptions): ActionConfig

Parameters

• scope Construct
• stage IStage
• options ActionBindOptions

Returns

• ActionConfig

This is a renamed version of the {@link IAction.bind} method.

---

protected variableExpression(variableName)

protected variableExpression(variableName: string): string

Parameters

• variableName string

Returns

• string