Package software.amazon.awscdk.services.codepipeline.actions

Interface LambdaInvokeActionProps

All Superinterfaces:

CommonActionProps, CommonAwsActionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LambdaInvokeActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:04.548Z")
@Stability(Stable)
public interface LambdaInvokeActionProps
extends software.amazon.jsii.JsiiSerializable, CommonAwsActionProps

Construction properties of the LambdaInvokeAction Lambda invoke CodePipeline Action.

Example:

 Function fn;
 Pipeline pipeline = new Pipeline(this, "MyPipeline");
 LambdaInvokeAction lambdaAction = LambdaInvokeAction.Builder.create()
         .actionName("Lambda")
         .lambda(fn)
         .build();
 pipeline.addStage(StageOptions.builder()
         .stageName("Lambda")
         .actions(List.of(lambdaAction))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	LambdaInvokeActionProps.Builder	A builder for LambdaInvokeActionProps
static final class	LambdaInvokeActionProps.Jsii$Proxy	An implementation for LambdaInvokeActionProps

Method Summary

Modifier and Type	Method	Description
static LambdaInvokeActionProps.Builder	builder()
default List<Artifact>	getInputs()	The optional input Artifacts of the Action.
IFunction	getLambda()	The lambda function to invoke.
default List<Artifact>	getOutputs()	The optional names of the output Artifacts of the Action.
default Map<String,Object>	getUserParameters()	A set of key-value pairs that will be accessible to the invoked Lambda inside the event that the Pipeline will call it with.
default String	getUserParametersString()	The string representation of the user parameters that will be accessible to the invoked Lambda inside the event that the Pipeline will call it with.

Methods inherited from interface software.amazon.awscdk.services.codepipeline.CommonActionProps

getActionName, getRunOrder, getVariablesNamespace

Methods inherited from interface software.amazon.awscdk.services.codepipeline.CommonAwsActionProps

getRole

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLambda

@Stability(Stable)
@NotNull
IFunction getLambda()

The lambda function to invoke.

getInputs

@Stability(Stable)
@Nullable
default List<Artifact> getInputs()

The optional input Artifacts of the Action.

A Lambda Action can have up to 5 inputs. The inputs will appear in the event passed to the Lambda, under the 'CodePipeline.job'.data.inputArtifacts path.

Default: the Action will not have any inputs

See Also:

• https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-invoke-lambda-function.html#actions-invoke-lambda-function-json-event-example

getOutputs

@Stability(Stable)
@Nullable
default List<Artifact> getOutputs()

The optional names of the output Artifacts of the Action.

A Lambda Action can have up to 5 outputs. The outputs will appear in the event passed to the Lambda, under the 'CodePipeline.job'.data.outputArtifacts path. It is the responsibility of the Lambda to upload ZIP files with the Artifact contents to the provided locations.

Default: the Action will not have any outputs

getUserParameters

@Stability(Stable)
@Nullable
default Map<String,Object> getUserParameters()

A set of key-value pairs that will be accessible to the invoked Lambda inside the event that the Pipeline will call it with.

Only one of userParameters or userParametersString can be specified.

Default: - no user parameters will be passed

See Also:

• https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-invoke-lambda-function.html#actions-invoke-lambda-function-json-event-example

getUserParametersString

@Stability(Stable)
@Nullable
default String getUserParametersString()

The string representation of the user parameters that will be accessible to the invoked Lambda inside the event that the Pipeline will call it with.

Only one of userParametersString or userParameters can be specified.

Default: - no user parameters will be passed

builder

@Stability(Stable)
static LambdaInvokeActionProps.Builder builder()

Returns:

a LambdaInvokeActionProps.Builder of LambdaInvokeActionProps