class LambdaInvokeAction

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

Implements IAction

Extends Action

CodePipeline invoke Action that is provided by an AWS Lambda function.

See also: https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-invoke-lambda-function.html

Example

declare const fn: lambda.Function;
const pipeline = new codepipeline.Pipeline(this, 'MyPipeline');
const lambdaAction = new codepipeline_actions.LambdaInvokeAction({
  actionName: 'Lambda',
  lambda: fn,
});
pipeline.addStage({
  stageName: 'Lambda',
  actions: [lambdaAction],
});

Initializer

new LambdaInvokeAction(props: LambdaInvokeActionProps)

Parameters

• props LambdaInvokeActionProps

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 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.
variable(variableName)	Reference a CodePipeline variable defined by the Lambda function this action points to.
protected bound(scope, _stage, options)	This is a renamed version of the IAction.bind method.

---

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.

---

variable(variableName)

public variable(variableName: string): string

Parameters

• variableName string — the name of the variable to reference.

Returns

• string

Reference a CodePipeline variable defined by the Lambda function this action points to.

Variables in Lambda invoke actions are defined by calling the PutJobSuccessResult CodePipeline API call with the 'outputVariables' property filled.

See also: https://docs.aws.amazon.com/codepipeline/latest/APIReference/API_PutJobSuccessResult.html

---

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 IAction.bind method.