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(Stable) public static final class LambdaInvokeAction.Builder extends Object implements software.amazon.jsii.Builder<LambdaInvokeAction>
A fluent builder for LambdaInvokeAction.
  • Method Details

    • create

      @Stability(Stable) public static LambdaInvokeAction.Builder create()
      Returns:
      a new instance of LambdaInvokeAction.Builder.
    • actionName

      @Stability(Stable) public LambdaInvokeAction.Builder actionName(String actionName)
      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(Stable) public LambdaInvokeAction.Builder runOrder(Number runOrder)
      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:
    • variablesNamespace

      @Stability(Stable) public LambdaInvokeAction.Builder variablesNamespace(String variablesNamespace)
      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(Stable) public LambdaInvokeAction.Builder role(IRole 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

      invalid @link
      IAction.bind
      method in the
      invalid @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(Stable) public LambdaInvokeAction.Builder lambda(IFunction lambda)
      The lambda function to invoke.

      Parameters:
      lambda - The lambda function to invoke. This parameter is required.
      Returns:
      this
    • inputs

      @Stability(Stable) public LambdaInvokeAction.Builder inputs(List<? extends Artifact> 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.

      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:
    • outputs

      @Stability(Stable) public LambdaInvokeAction.Builder outputs(List<? extends Artifact> 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.

      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(Stable) public LambdaInvokeAction.Builder userParameters(Map<String,? extends Object> 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.

      Default: - no user parameters will be passed

      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:
    • userParametersString

      @Stability(Stable) public LambdaInvokeAction.Builder userParametersString(String 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.

      Default: - no user parameters will be passed

      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. This parameter is required.
      Returns:
      this
    • build

      @Stability(Stable) public LambdaInvokeAction build()
      Specified by:
      build in interface software.amazon.jsii.Builder<LambdaInvokeAction>
      Returns:
      a newly built instance of LambdaInvokeAction.