Interface GatewayTargetLambdaProps
- All Superinterfaces:
GatewayTargetCommonProps,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
GatewayTargetLambdaProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.129.0 (build eaca441)",
date="2026-05-19T08:18:44.415Z")
@Stability(Stable)
public interface GatewayTargetLambdaProps
extends software.amazon.jsii.JsiiSerializable, GatewayTargetCommonProps
Properties for creating a Lambda-based Gateway Target Convenience interface for the most common use case.
Example:
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();
// Create a gateway target with Lambda and tool schema
GatewayTarget target = GatewayTarget.forLambda(this, "MyLambdaTarget", GatewayTargetLambdaProps.builder()
.gatewayTargetName("my-lambda-target")
.description("Target for Lambda function integration")
.gateway(gateway)
.lambdaFunction(lambdaFunction)
.toolSchema(ToolSchema.fromLocalAsset(path.join(__dirname, "schemas", "my-tool-schema.json")))
.build());
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forGatewayTargetLambdaPropsstatic final classAn implementation forGatewayTargetLambdaProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default List<ICredentialProviderConfig> Credential providers for authentication Lambda targets only support IAM role authentication.The gateway this target belongs to.The Lambda function to associate with this target.The tool schema defining the available tools.Methods inherited from interface software.amazon.awscdk.services.bedrockagentcore.GatewayTargetCommonProps
getDescription, getGatewayTargetNameMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getGateway
The gateway this target belongs to. -
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 Lambda targets only support IAM role authentication.Default: - [GatewayCredentialProvider.fromIamRole()]
-
builder
- Returns:
- a
GatewayTargetLambdaProps.BuilderofGatewayTargetLambdaProps
-