software.amazon.awscdk.services.lambda

Interface CommonPipelineInvokeActionProps

All Superinterfaces:

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

All Known Subinterfaces:

PipelineInvokeActionProps

All Known Implementing Classes:

CommonPipelineInvokeActionProps.Jsii$Proxy, PipelineInvokeActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/0.7.8 (build 100f5ad)",
           date="2018-10-26T17:58:07.463Z")
public interface CommonPipelineInvokeActionProps
extends software.amazon.jsii.JsiiSerializable, software.amazon.awscdk.services.codepipeline.api.CommonActionProps

Common properties for creating a PipelineInvokeAction - either directly, through its constructor, or through FunctionRef.addToPipeline(software.amazon.awscdk.services.codepipeline.api.IStage, java.lang.String, software.amazon.awscdk.services.lambda.CommonPipelineInvokeActionProps).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CommonPipelineInvokeActionProps.Builder A builder for CommonPipelineInvokeActionProps
static class	CommonPipelineInvokeActionProps.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
static CommonPipelineInvokeActionProps.Builder	builder()
Boolean	getAddPutJobResultPolicy() Adds the "codepipeline:PutJobSuccessResult" and "codepipeline:PutJobFailureResult" for '*' resource to the Lambda execution role policy.
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	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

getRunOrder, setRunOrder

Method Detail

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

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

builder

static CommonPipelineInvokeActionProps.Builder builder()

Specified by:

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

Returns:

a CommonPipelineInvokeActionProps.Builder of CommonPipelineInvokeActionProps