aws-cdk-lib.aws_codepipeline.IAction

IAction Interface

A Pipeline Action.

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

IAction

implemented by

• Action,
• Action,
• AlexaSkillDeployAction,
• 29 more

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

Source

aws-codepipeline/lib/action.ts

Properties

actionPropertiesActionPropertiesaction_propertiesActionPropertiesactionPropertiesActionPropertiesActionPropertiesActionPropertiesActionPropertiesActionPropertiesrequired#

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

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

Methods

bind(scope: Construct, stage: IStage, options: ActionBindOptions): ActionConfigdef bind(self, scope: Construct, stage: IStage, options: ActionBindOptions) -> ActionConfigpublic ActionConfig bind(Construct scope, IStage stage, ActionBindOptions options)public ActionConfig Bind(Construct scope, IStage stage, ActionBindOptions options)func Bind(Scope Construct, Stage IStage, Options ActionBindOptions) ActionConfig#

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

3 parameters

Parameters

• scopescopescopescopeScope — the Construct tree scope the Action can use if it needs to create any resources.
• stagestagestagestageStage — the IStage this Action is being added to.
• optionsoptionsoptionsoptionsOptions — additional options the Action can use, like the artifact Bucket of the pipeline it's being added to.

onStateChange(name: string, target?: IRuleTarget, options?: RuleProps): Ruledef on_state_change(self, name: str, target: typing.Optional[IRuleTarget] = None, options: typing.Optional[RuleProps] = None) -> Rulepublic Rule onStateChange(String name, IRuleTarget target, RuleProps options)public Rule OnStateChange(string name, IRuleTarget? target = null, RuleProps? options = null)func OnStateChange(Name *string, Target IRuleTarget, Options RuleProps) Rule#

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

3 parameters

Parameters

• namenamenamenameName — the name to use for the new Event.
• targettargettargettargetTarget — the optional target for the Event.
• optionsoptionsoptionsoptionsOptions — additional options that can be used to customize the created Event.