interface IAction

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

Implemented by PipelineDeployStackAction, AlexaSkillDeployAction, BitBucketSourceAction, CloudFormationCreateReplaceChangeSetAction, CloudFormationCreateUpdateStackAction, CloudFormationDeleteStackAction, CloudFormationDeployStackInstancesAction, CloudFormationDeployStackSetAction, CloudFormationExecuteChangeSetAction, CodeBuildAction, CodeCommitSourceAction, CodeDeployEcsDeployAction, CodeDeployServerDeployAction, CodeStarConnectionsSourceAction, EcrSourceAction, EcsDeployAction, GitHubSourceAction, JenkinsAction, LambdaInvokeAction, ManualApprovalAction, S3DeployAction, S3SourceAction, ServiceCatalogDeployActionBeta1, StepFunctionInvokeAction, DeployCdkStackAction, PublishAssetsAction, ShellScriptAction, SimpleSynthAction, UpdatePipelineAction

A Pipeline Action.

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

Properties

Name	Type	Description
actionProperties	ActionProperties	The simple properties of the Action, like its Owner, name, etc.

---

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.

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 — the Construct tree scope the Action can use if it needs to create any resources.
• stage IStage — the {@link IStage} this Action is being added to.
• options ActionBindOptions — additional options the Action can use, like the artifact Bucket of the pipeline it's being added to.

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 — the name to use for the new Event.
• target IRuleTarget — the optional target for the Event.
• options RuleProps — additional options that can be used to customize the created Event.

Returns

• Rule

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