Package software.amazon.awscdk.services.codepipeline

Interface IAction

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IAction.Jsii$Default

All Known Implementing Classes:

Action, Action, AlexaSkillDeployAction, BitBucketSourceAction, CloudFormationCreateReplaceChangeSetAction, CloudFormationCreateUpdateStackAction, CloudFormationDeleteStackAction, CloudFormationDeployStackInstancesAction, CloudFormationDeployStackSetAction, CloudFormationExecuteChangeSetAction, CodeBuildAction, CodeCommitSourceAction, CodeDeployEcsDeployAction, CodeDeployServerDeployAction, CodeStarConnectionsSourceAction, DeployCdkStackAction, EcrSourceAction, EcsDeployAction, GitHubSourceAction, IAction.Jsii$Proxy, JenkinsAction, LambdaInvokeAction, ManualApprovalAction, PipelineDeployStackAction, PublishAssetsAction, S3DeployAction, S3SourceAction, ServiceCatalogDeployActionBeta1, ShellScriptAction, SimpleSynthAction, StepFunctionInvokeAction, UpdatePipelineAction

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:37.936Z")
@Stability(Stable)
public interface IAction
extends software.amazon.jsii.JsiiSerializable

A Pipeline Action.

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IAction.Jsii$Default	Internal default implementation for IAction.
static final class	IAction.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
ActionConfig	bind(Construct scope, IStage stage, ActionBindOptions options)	The callback invoked when this Action is added to a Pipeline.
ActionProperties	getActionProperties()	The simple properties of the Action, like its Owner, name, etc.
Rule	onStateChange(String name)	Creates an Event that will be triggered whenever the state of this Action changes.
Rule	onStateChange(String name, IRuleTarget target)	Creates an Event that will be triggered whenever the state of this Action changes.
Rule	onStateChange(String name, IRuleTarget target, RuleProps options)	Creates an Event that will be triggered whenever the state of this Action changes.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActionProperties

@Stability(Stable)
@NotNull
ActionProperties getActionProperties()

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

Note that this accessor will be called before the bind(software.amazon.awscdk.core.Construct,software.amazon.awscdk.services.codepipeline.IStage,software.amazon.awscdk.services.codepipeline.ActionBindOptions) callback.

bind

@Stability(Stable)
@NotNull
ActionConfig bind(@NotNull
 Construct scope,
 @NotNull
 IStage stage,
 @NotNull
 ActionBindOptions options)

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

Parameters:

scope - the Construct tree scope the Action can use if it needs to create any resources. This parameter is required.

stage - the IStage this Action is being added to. This parameter is required.

options - additional options the Action can use, like the artifact Bucket of the pipeline it's being added to. This parameter is required.

onStateChange

@Stability(Stable)
@NotNull
Rule onStateChange(@NotNull
 String name,
 @Nullable
 IRuleTarget target,
 @Nullable
 RuleProps options)

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

Parameters:

name - the name to use for the new Event. This parameter is required.

target - the optional target for the Event.

options - additional options that can be used to customize the created Event.

onStateChange

@Stability(Stable)
@NotNull
Rule onStateChange(@NotNull
 String name,
 @Nullable
 IRuleTarget target)

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

Parameters:

name - the name to use for the new Event. This parameter is required.

target - the optional target for the Event.

onStateChange

@Stability(Stable)
@NotNull
Rule onStateChange(@NotNull
 String name)

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

Parameters:

name - the name to use for the new Event. This parameter is required.