> **Experimental**
>
> `@aws-cdk/integ-tests-alpha` is an [**experimental**](/stability) (alpha) package: its API may change in any release, without a major version bump.
# LambdaInvokeFunctionProps

Options to pass to the Lambda invokeFunction API call.

Used as props by: [LambdaInvokeFunction](/cdk/api/v2/docs/@aws-cdk_integ-tests-alpha.LambdaInvokeFunction.html)

- Stability: [Experimental](/cdk/api/stability.html)
- Source: [`lib/assertions/sdk.ts`](https://github.com/aws/aws-cdk/blob/v2.277.0/packages/@aws-cdk/integ-tests-alpha/lib/assertions/sdk.ts#L205)

## Example

TypeScript:

```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:

```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:

```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")));
```

C# / .NET:

```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" }
}));
```

Golang:

```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

- `functionName`: string (required) — The name of the function to invoke.

- `invocationType`: [InvocationType](/cdk/api/v2/docs/@aws-cdk_integ-tests-alpha.InvocationType.html) = InvocationType.REQUEST_RESPONSE — The type of invocation to use.

- `logRetention`: [RetentionDays](/cdk/api/v2/docs/aws-cdk-lib.aws_logs.RetentionDays.html) — How long, in days, the log contents will be retained.

  **Default:** no retention days specified

- `logType`: [LogType](/cdk/api/v2/docs/@aws-cdk_integ-tests-alpha.LogType.html) = LogType.NONE — Whether to return the logs as part of the response.

- `payload`: string — Payload to send as part of the invoke.

  **Default:** no payload
