software.amazon.awscdk.services.lambda

Interface PipelineInvokeActionProps

All Superinterfaces:

software.amazon.awscdk.services.codepipeline.api.CommonActionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PipelineInvokeActionProps.Jsii$Pojo, PipelineInvokeActionProps.Jsii$Proxy

public interface PipelineInvokeActionProps
extends software.amazon.jsii.JsiiSerializable, software.amazon.awscdk.services.codepipeline.api.CommonActionProps

Construction properties of the Lambda invoke CodePipeline Action.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PipelineInvokeActionProps.Builder A fluent step builder class for PipelineInvokeActionProps.
static class	PipelineInvokeActionProps.Jsii$Pojo A PoJo (plain-old-java-object) class that implements PipelineInvokeActionProps.
static class	PipelineInvokeActionProps.Jsii$Proxy A proxy class which for javascript object literal which adhere to this interface.

Method Summary

Modifier and Type	Method and Description
static PipelineInvokeActionProps.Builder	builder()
Boolean	getAddPutJobResultPolicy() Adds the "codepipeline:PutJobSuccessResult" and "codepipeline:PutJobFailureResult" for '*' resource to the Lambda execution role policy.
FunctionRef	getLambda() The lambda function to invoke.
Object	getUserParameters() String to be used in the event data parameter passed to the Lambda function See an example JSON event in the CodePipeline documentation.
void	setAddPutJobResultPolicy(Boolean value) Adds the "codepipeline:PutJobSuccessResult" and "codepipeline:PutJobFailureResult" for '*' resource to the Lambda execution role policy.
void	setLambda(FunctionRef value) The lambda function to invoke.
void	setUserParameters(Object value) String to be used in the event data parameter passed to the Lambda function See an example JSON event in the CodePipeline documentation.

Methods inherited from interface software.amazon.awscdk.services.codepipeline.api.CommonActionProps

getStage, setStage

Method Detail

getLambda

FunctionRef getLambda()

The lambda function to invoke.

setLambda

void setLambda(FunctionRef value)

The lambda function to invoke.

getUserParameters

Object getUserParameters()

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

setUserParameters

void setUserParameters(Object 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

getAddPutJobResultPolicy

Boolean getAddPutJobResultPolicy()

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.

See Also:

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

setAddPutJobResultPolicy

void setAddPutJobResultPolicy(Boolean 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.

See Also:

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

builder

static PipelineInvokeActionProps.Builder builder()

Specified by:

builder in interface software.amazon.awscdk.services.codepipeline.api.CommonActionProps