software.amazon.awscdk.services.lambda

Class PipelineInvokeActionProps.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.PipelineInvokeActionProps.Builder

Enclosing interface:

PipelineInvokeActionProps

public static final class PipelineInvokeActionProps.Builder
extends Object

A builder for PipelineInvokeActionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
PipelineInvokeActionProps	build() Builds the configured instance.
PipelineInvokeActionProps.Builder	withAddPutJobResultPolicy(Boolean value) Sets the value of AddPutJobResultPolicy
PipelineInvokeActionProps.Builder	withLambda(FunctionRef value) Sets the value of Lambda
PipelineInvokeActionProps.Builder	withRunOrder(Number value) Sets the value of RunOrder
PipelineInvokeActionProps.Builder	withStage(software.amazon.awscdk.services.codepipeline.api.IStage value) Sets the value of Stage
PipelineInvokeActionProps.Builder	withUserParameters(Object value) Sets the value of UserParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

withLambda

public PipelineInvokeActionProps.Builder withLambda(FunctionRef value)

Sets the value of Lambda

Parameters:

value - The lambda function to invoke.

Returns:

this

withAddPutJobResultPolicy

public PipelineInvokeActionProps.Builder withAddPutJobResultPolicy(@Nullable
                                                                   Boolean value)

Sets the value of AddPutJobResultPolicy

Parameters:

value - Adds the "codepipeline:PutJobSuccessResult" and "codepipeline:PutJobFailureResult" for '*' resource to the Lambda execution role policy. NOTE: the reason we can't add the specific pipeline ARN as a resource is to avoid a cyclic dependency between the pipeline and the Lambda function (the pipeline references) the Lambda and the Lambda needs permissions on the pipeline.

Returns:

this

withUserParameters

public PipelineInvokeActionProps.Builder withUserParameters(@Nullable
                                                            Object value)

Sets the value of UserParameters

Parameters:

value - String to be used in the event data parameter passed to the Lambda function See an example JSON event in the CodePipeline documentation. https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-invoke-lambda-function.html#actions-invoke-lambda-function-json-event-example

Returns:

this

withRunOrder

public PipelineInvokeActionProps.Builder withRunOrder(@Nullable
                                                      Number value)

Sets the value of RunOrder

Parameters:

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

Returns:

this

withStage

public PipelineInvokeActionProps.Builder withStage(software.amazon.awscdk.services.codepipeline.api.IStage value)

Sets the value of Stage

Parameters:

value - The Pipeline Stage to add this Action to.

Returns:

this

build

public PipelineInvokeActionProps build()

Builds the configured instance.

Returns:

a new instance of PipelineInvokeActionProps

Throws:

NullPointerException - if any required attribute was not provided