software.amazon.awscdk.services.codepipeline.actions

Class LambdaInvokeAction.Builder

java.lang.Object

software.amazon.awscdk.services.codepipeline.actions.LambdaInvokeAction.Builder

Enclosing class:

LambdaInvokeAction

@Stability(value=Stable)
public static final class LambdaInvokeAction.Builder
extends Object

A fluent builder for LambdaInvokeAction.

Method Summary

Modifier and Type	Method and Description
LambdaInvokeAction.Builder	actionName(String actionName)
LambdaInvokeAction	build()
static LambdaInvokeAction.Builder	create()
LambdaInvokeAction.Builder	inputs(List<Artifact> inputs)
LambdaInvokeAction.Builder	lambda(IFunction lambda)
LambdaInvokeAction.Builder	outputs(List<Artifact> outputs)
LambdaInvokeAction.Builder	role(IRole role)
LambdaInvokeAction.Builder	runOrder(Number runOrder)
LambdaInvokeAction.Builder	userParameters(Map<String,Object> userParameters)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static LambdaInvokeAction.Builder create()

Returns:

a new instance of LambdaInvokeAction.Builder.

actionName

@Stability(value=Stable)
public LambdaInvokeAction.Builder actionName(String actionName)

Parameters:

actionName - The physical, human-readable name of the Action. Not that Action names must be unique within a single Stage. This parameter is required.

Returns:

this

runOrder

@Stability(value=Stable)
public LambdaInvokeAction.Builder runOrder(Number runOrder)

Parameters:

runOrder - The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute. This parameter is required.

Returns:

this

role

@Stability(value=Stable)
public LambdaInvokeAction.Builder role(IRole role)

Parameters:

role - The Role in which context's this Action will be executing in. The Pipeline's Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your IAction.bind method in the ActionBindOptions.role property. This parameter is required.

Returns:

this

lambda

@Stability(value=Stable)
public LambdaInvokeAction.Builder lambda(IFunction lambda)

Parameters:

lambda - The lambda function to invoke. This parameter is required.

Returns:

this

inputs

@Stability(value=Stable)
public LambdaInvokeAction.Builder inputs(List<Artifact> inputs)

Parameters:

inputs - 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. This parameter is required.

Returns:

this

outputs

@Stability(value=Stable)
public LambdaInvokeAction.Builder outputs(List<Artifact> outputs)

Parameters:

outputs - 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. This parameter is required.

Returns:

this

userParameters

@Stability(value=Stable)
public LambdaInvokeAction.Builder userParameters(Map<String,Object> userParameters)

Parameters:

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

Returns:

this

build

@Stability(value=Stable)
public LambdaInvokeAction build()