software.amazon.awscdk.services.lambda

Class CommonPipelineInvokeActionProps.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.CommonPipelineInvokeActionProps.Builder

Enclosing interface:

CommonPipelineInvokeActionProps

public static final class CommonPipelineInvokeActionProps.Builder
extends Object

A builder for CommonPipelineInvokeActionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CommonPipelineInvokeActionProps	build() Builds the configured instance.
CommonPipelineInvokeActionProps.Builder	withAddPutJobResultPolicy(Boolean value) Sets the value of AddPutJobResultPolicy
CommonPipelineInvokeActionProps.Builder	withRunOrder(Number value) Sets the value of RunOrder
CommonPipelineInvokeActionProps.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

withAddPutJobResultPolicy

public CommonPipelineInvokeActionProps.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 CommonPipelineInvokeActionProps.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 CommonPipelineInvokeActionProps.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

build

public CommonPipelineInvokeActionProps build()

Builds the configured instance.

Returns:

a new instance of CommonPipelineInvokeActionProps

Throws:

NullPointerException - if any required attribute was not provided