Skip to content
v2.277.0

Experimental

@aws-cdk/integ-tests-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

LambdaInvokeFunctionProps Struct ​

Options to pass to the Lambda invokeFunction API call.

Example ​

ts
declare const lambdaFunction: lambda.IFunction;
declare const app: App;

const stack = new Stack(app, 'cdk-integ-lambda-bundling');

const integ = new IntegTest(app, 'IntegTest', {
  testCases: [stack],
});

const invoke = integ.assertions.invokeFunction({
  functionName: lambdaFunction.functionName,
});
invoke.expect(ExpectedResult.objectLike({
  Payload: '200',
}));
python
# lambda_function: lambda.IFunction
# app: App


stack = Stack(app, "cdk-integ-lambda-bundling")

integ = IntegTest(app, "IntegTest",
    test_cases=[stack]
)

invoke = integ.assertions.invoke_function(
    function_name=lambda_function.function_name
)
invoke.expect(ExpectedResult.object_like({
    "Payload": "200"
}))
java
IFunction lambdaFunction;
App app;


Stack stack = new Stack(app, "cdk-integ-lambda-bundling");

IntegTest integ = IntegTest.Builder.create(app, "IntegTest")
        .testCases(List.of(stack))
        .build();

IApiCall invoke = integ.assertions.invokeFunction(LambdaInvokeFunctionProps.builder()
        .functionName(lambdaFunction.getFunctionName())
        .build());
invoke.expect(ExpectedResult.objectLike(Map.of(
        "Payload", "200")));
csharp
// Install: dotnet add package Amazon.CDK.IntegTests.Alpha
IFunction lambdaFunction;
App app;


var stack = new Stack(app, "cdk-integ-lambda-bundling");

var integ = new IntegTest(app, "IntegTest", new IntegTestProps {
    TestCases = new [] { stack }
});

var invoke = integ.Assertions.InvokeFunction(new LambdaInvokeFunctionProps {
    FunctionName = lambdaFunction.FunctionName
});
invoke.Expect(ExpectedResult.ObjectLike(new Dictionary<string, object> {
    { "Payload", "200" }
}));
go
// Install: go get github.com/aws/aws-cdk-go/awscdkintegtestsalpha/v2
var lambdaFunction IFunction
var app App


stack := awscdk.NewStack(app, jsii.String("cdk-integ-lambda-bundling"))

integ := awscdkintegtestsalpha.NewIntegTest(app, jsii.String("IntegTest"), &IntegTestProps{
	TestCases: []Stack{
		stack,
	},
})

invoke := integ.Assertions.InvokeFunction(&LambdaInvokeFunctionProps{
	FunctionName: lambdaFunction.FunctionName,
})
invoke.Expect(awscdkintegtestsalpha.ExpectedResult_ObjectLike(map[string]interface{}{
	"Payload": jsii.String("200"),
}))

Properties ​

functionNamestringfunction_namestrfunctionNameStringFunctionNamestringFunctionName*string required #
The name of the function to invoke.
invocationTypeoptionalInvocationTypeinvocation_typeoptionalInvocationTypeinvocationTypeoptionalInvocationTypeInvocationTypeoptionalInvocationTypeInvocationTypeoptionalInvocationType = InvocationType.REQUEST_RESPONSE #
The type of invocation to use.
logRetentionoptionalRetentionDayslog_retentionoptionalRetentionDayslogRetentionoptionalRetentionDaysLogRetentionoptionalRetentionDaysLogRetentionoptionalRetentionDays #
How long, in days, the log contents will be retained.

Default: no retention days specified

logTypeoptionalLogTypelog_typeoptionalLogTypelogTypeoptionalLogTypeLogTypeoptionalLogTypeLogTypeoptionalLogType = LogType.NONE #
Whether to return the logs as part of the response.
payloadoptionalstringpayloadoptionalstrpayloadoptionalStringPayloadoptionalstringPayloadoptional*string #
Payload to send as part of the invoke.

Default: no payload