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

Class LambdaInvokeActionProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<LambdaInvokeActionProps>

Enclosing interface:

LambdaInvokeActionProps

@Stability(Stable)
public static final class LambdaInvokeActionProps.Builder
extends Object
implements software.amazon.jsii.Builder<LambdaInvokeActionProps>

A builder for LambdaInvokeActionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
LambdaInvokeActionProps.Builder	actionName(String actionName)	Sets the value of CommonActionProps.getActionName()
LambdaInvokeActionProps	build()	Builds the configured instance.
LambdaInvokeActionProps.Builder	inputs(List<? extends Artifact> inputs)	Sets the value of LambdaInvokeActionProps.getInputs()
LambdaInvokeActionProps.Builder	lambda(IFunction lambda)	Sets the value of LambdaInvokeActionProps.getLambda()
LambdaInvokeActionProps.Builder	outputs(List<? extends Artifact> outputs)	Sets the value of LambdaInvokeActionProps.getOutputs()
LambdaInvokeActionProps.Builder	role(IRole role)	Sets the value of CommonAwsActionProps.getRole()
LambdaInvokeActionProps.Builder	runOrder(Number runOrder)	Sets the value of CommonActionProps.getRunOrder()
LambdaInvokeActionProps.Builder	userParameters(Map<String,? extends Object> userParameters)	Sets the value of LambdaInvokeActionProps.getUserParameters()
LambdaInvokeActionProps.Builder	userParametersString(String userParametersString)	Sets the value of LambdaInvokeActionProps.getUserParametersString()
LambdaInvokeActionProps.Builder	variablesNamespace(String variablesNamespace)	Sets the value of CommonActionProps.getVariablesNamespace()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

lambda

@Stability(Stable)
public LambdaInvokeActionProps.Builder lambda(IFunction lambda)

Sets the value of LambdaInvokeActionProps.getLambda()

Parameters:

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

Returns:

this

inputs

@Stability(Stable)
public LambdaInvokeActionProps.Builder inputs(List<? extends Artifact> inputs)

Sets the value of LambdaInvokeActionProps.getInputs()

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.

Returns:

this

outputs

@Stability(Stable)
public LambdaInvokeActionProps.Builder outputs(List<? extends Artifact> outputs)

Sets the value of LambdaInvokeActionProps.getOutputs()

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.

Returns:

this

userParameters

@Stability(Stable)
public LambdaInvokeActionProps.Builder userParameters(Map<String,? extends Object> userParameters)

Sets the value of LambdaInvokeActionProps.getUserParameters()

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. Only one of userParameters or userParametersString can be specified.

Returns:

this

userParametersString

@Stability(Stable)
public LambdaInvokeActionProps.Builder userParametersString(String userParametersString)

Sets the value of LambdaInvokeActionProps.getUserParametersString()

Parameters:

userParametersString - 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.

Returns:

this

role

@Stability(Stable)
public LambdaInvokeActionProps.Builder role(IRole role)

Sets the value of CommonAwsActionProps.getRole()

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.

Returns:

this

actionName

@Stability(Stable)
public LambdaInvokeActionProps.Builder actionName(String actionName)

Sets the value of CommonActionProps.getActionName()

Parameters:

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

Returns:

this

runOrder

@Stability(Stable)
public LambdaInvokeActionProps.Builder runOrder(Number runOrder)

Sets the value of CommonActionProps.getRunOrder()

Parameters:

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

Returns:

this

variablesNamespace

@Stability(Stable)
public LambdaInvokeActionProps.Builder variablesNamespace(String variablesNamespace)

Sets the value of CommonActionProps.getVariablesNamespace()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public LambdaInvokeActionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of LambdaInvokeActionProps

Throws:

NullPointerException - if any required attribute was not provided