software.amazon.awscdk.services.codepipeline.actions

Class LambdaInvokeAction.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<LambdaInvokeAction>

Enclosing class:

LambdaInvokeAction

@Stability(value=Experimental)
public static final class LambdaInvokeAction.Builder
extends Object
implements software.amazon.jsii.Builder<LambdaInvokeAction>

(experimental) A fluent builder for LambdaInvokeAction.

Method Summary

Modifier and Type	Method and Description
LambdaInvokeAction.Builder	actionName(String actionName) (experimental) The physical, human-readable name of the Action.
LambdaInvokeAction	build()
static LambdaInvokeAction.Builder	create()
LambdaInvokeAction.Builder	inputs(List<? extends Artifact> inputs) (experimental) The optional input Artifacts of the Action.
LambdaInvokeAction.Builder	lambda(IFunction lambda) (experimental) The lambda function to invoke.
LambdaInvokeAction.Builder	outputs(List<? extends Artifact> outputs) (experimental) The optional names of the output Artifacts of the Action.
LambdaInvokeAction.Builder	role(IRole role) (experimental) The Role in which context's this Action will be executing in.
LambdaInvokeAction.Builder	runOrder(Number runOrder) (experimental) The runOrder property for this Action.
LambdaInvokeAction.Builder	userParameters(Map<String,? extends Object> userParameters) (experimental) A set of key-value pairs that will be accessible to the invoked Lambda inside the event that the Pipeline will call it with.
LambdaInvokeAction.Builder	variablesNamespace(String variablesNamespace) (experimental) The name of the namespace to use for variables emitted by this action.

Methods inherited from class java.lang.Object

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

Method Detail

create

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

Returns:

a new instance of LambdaInvokeAction.Builder.

actionName

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

(experimental) The physical, human-readable name of the Action.

Note that Action names must be unique within a single Stage.

Parameters:

actionName - The physical, human-readable name of the Action. This parameter is required.

Returns:

this

runOrder

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

(experimental) The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Default: 1

Parameters:

runOrder - The runOrder property for this Action. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html

variablesNamespace

@Stability(value=Experimental)
public LambdaInvokeAction.Builder variablesNamespace(String variablesNamespace)

(experimental) The name of the namespace to use for variables emitted by this action.

Default: - a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set

Parameters:

variablesNamespace - The name of the namespace to use for variables emitted by this action. This parameter is required.

Returns:

this

role

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

(experimental) 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 {@link IAction.bind} method in the {@link ActionBindOptions.role} property.

Default: a new Role will be generated

Parameters:

role - The Role in which context's this Action will be executing in. This parameter is required.

Returns:

this

lambda

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

(experimental) The lambda function to invoke.

Parameters:

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

Returns:

this

inputs

@Stability(value=Experimental)
public LambdaInvokeAction.Builder inputs(List<? extends Artifact> inputs)

(experimental) 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

Parameters:

inputs - The optional input Artifacts of the Action. This parameter is required.

Returns:

this

See Also:

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

outputs

@Stability(value=Experimental)
public LambdaInvokeAction.Builder outputs(List<? extends Artifact> outputs)

(experimental) 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

Parameters:

outputs - The optional names of the output Artifacts of the Action. This parameter is required.

Returns:

this

userParameters

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

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

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

See Also:

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

build

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

Specified by:

build in interface software.amazon.jsii.Builder<LambdaInvokeAction>