Interface AddLambdaTargetOptions
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
AddLambdaTargetOptions.Jsii$Proxy
@Generated(value="jsii-pacmak/1.130.0 (build 048a5ee)",
date="2026-05-19T19:44:36.887Z")
@Stability(Stable)
public interface AddLambdaTargetOptions
extends software.amazon.jsii.JsiiSerializable
Options for adding a Lambda target to a gateway.
Example:
// Create a gateway first
Gateway gateway = Gateway.Builder.create(this, "MyGateway")
.gatewayName("my-gateway")
.build();
Function lambdaFunction = Function.Builder.create(this, "MyFunction")
.runtime(Runtime.NODEJS_22_X)
.handler("index.handler")
.code(Code.fromInline("\n exports.handler = async (event) => {\n return {\n statusCode: 200,\n body: JSON.stringify({ message: 'Hello from Lambda!' })\n };\n };\n "))
.build();
GatewayTarget lambdaTarget = gateway.addLambdaTarget("MyLambdaTarget", AddLambdaTargetOptions.builder()
.gatewayTargetName("my-lambda-target")
.description("Lambda function target")
.lambdaFunction(lambdaFunction)
.toolSchema(ToolSchema.fromInline(List.of(ToolDefinition.builder()
.name("hello_world")
.description("A simple hello world tool")
.inputSchema(SchemaDefinition.builder()
.type(SchemaDefinitionType.OBJECT)
.properties(Map.of(
"name", SchemaDefinition.builder()
.type(SchemaDefinitionType.STRING)
.description("The name to greet")
.build()))
.required(List.of("name"))
.build())
.build())))
.build());
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forAddLambdaTargetOptionsstatic final classAn implementation forAddLambdaTargetOptions -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default List<ICredentialProviderConfig> Credential providers for authentication.default StringOptional description for the gateway target.default StringThe name of the gateway target Valid characters are a-z, A-Z, 0-9, _ (underscore) and - (hyphen).The Lambda function to associate with this target.The tool schema defining the available tools.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getLambdaFunction
The Lambda function to associate with this target. -
getToolSchema
The tool schema defining the available tools. -
getCredentialProviderConfigurations
@Stability(Stable) @Nullable default List<ICredentialProviderConfig> getCredentialProviderConfigurations()Credential providers for authentication.Default: - [GatewayCredentialProvider.iamRole()]
-
getDescription
Optional description for the gateway target.Default: - No description
-
getGatewayTargetName
The name of the gateway target Valid characters are a-z, A-Z, 0-9, _ (underscore) and - (hyphen).Default: - auto generate
-
builder
- Returns:
- a
AddLambdaTargetOptions.BuilderofAddLambdaTargetOptions
-