class Action

Language	Type name
.NET	Amazon.CDK.AWS.CodePipeline.Actions.Action
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscodepipelineactions#Action
Java	software.amazon.awscdk.services.codepipeline.actions.Action
Python	aws_cdk.aws_codepipeline_actions.Action
TypeScript (source)	aws-cdk-lib » aws_codepipeline_actions » Action

Implements IAction

Extends Action

Implemented by AlexaSkillDeployAction, CloudFormationCreateReplaceChangeSetAction, CloudFormationCreateUpdateStackAction, CloudFormationDeleteStackAction, CloudFormationDeployStackInstancesAction, CloudFormationDeployStackSetAction, CloudFormationExecuteChangeSetAction, CodeBuildAction, CodeCommitSourceAction, CodeDeployEcsDeployAction, CodeDeployServerDeployAction, CodeStarConnectionsSourceAction, CommandsAction, Ec2DeployAction, EcrBuildAndPublishAction, EcrSourceAction, EcsDeployAction, ElasticBeanstalkDeployAction, GitHubSourceAction, InspectorEcrImageScanAction, InspectorSourceCodeScanAction, JenkinsAction, LambdaInvokeAction, ManualApprovalAction, PipelineInvokeAction, S3DeployAction, S3SourceAction, ServiceCatalogDeployActionBeta1, StepFunctionInvokeAction

Obtainable from CodePipelineSource.getAction()

Low-level class for generic CodePipeline Actions.

If you're implementing your own IAction, prefer to use the Action class from the codepipeline module.

Initializer (protected)

super(actionProperties: ActionProperties)

Parameters

• actionProperties ActionProperties — The simple properties of the Action, like its Owner, name, etc.

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 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 bind callback.

---

providedActionProperties

Type: ActionProperties

This is a renamed version of the 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.

---

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.