2.227.0

interface GatewayTargetLambdaProps 🔹

LanguageType name
.NETAmazon.CDK.AWS.Bedrock.Agentcore.Alpha.GatewayTargetLambdaProps
Gogithub.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#GatewayTargetLambdaProps
Javasoftware.amazon.awscdk.services.bedrock.agentcore.alpha.GatewayTargetLambdaProps
Pythonaws_cdk.aws_bedrock_agentcore_alpha.GatewayTargetLambdaProps
TypeScript (source)@aws-cdk/aws-bedrock-agentcore-alpha » GatewayTargetLambdaProps

Properties for creating a Lambda-based Gateway Target Convenience interface for the most common use case.

Example

const gateway = new agentcore.Gateway(this, "MyGateway", {
  gatewayName: "my-gateway",
});

const lambdaFunction = new lambda.Function(this, "MyFunction", {
  runtime: lambda.Runtime.NODEJS_22_X,
  handler: "index.handler",
  code: lambda.Code.fromInline(`
        exports.handler = async (event) => {
            return {
                statusCode: 200,
                body: JSON.stringify({ message: 'Hello from Lambda!' })
            };
        };
    `),
});

// Create a gateway target with Lambda and tool schema
const target = agentcore.GatewayTarget.forLambda(this, "MyLambdaTarget", {
  gatewayTargetName: "my-lambda-target",
  description: "Target for Lambda function integration",
  gateway: gateway,
  lambdaFunction: lambdaFunction,
  toolSchema: agentcore.ToolSchema.fromLocalAsset(
    path.join(__dirname, "schemas", "my-tool-schema.json")
  ),
});

Properties

NameTypeDescription
gateway🔹IGatewayThe gateway this target belongs to.
gatewayTargetName🔹stringThe name of the gateway target The name must be unique within the gateway Pattern: ^([0-9a-zA-Z][-]?){1,100}$.
lambdaFunction🔹IFunctionThe Lambda function to associate with this target.
toolSchema🔹ToolSchemaThe tool schema defining the available tools.
credentialProviderConfigurations?🔹ICredentialProviderConfig[]Credential providers for authentication Lambda targets only support IAM role authentication.
description?🔹stringOptional description for the gateway target The description can have up to 200 characters.

gateway🔹

Type: IGateway

The gateway this target belongs to.

gatewayTargetName🔹

Type: string

The name of the gateway target The name must be unique within the gateway Pattern: ^([0-9a-zA-Z][-]?){1,100}$.

lambdaFunction🔹

Type: IFunction

The Lambda function to associate with this target.

toolSchema🔹

Type: ToolSchema

The tool schema defining the available tools.

credentialProviderConfigurations?🔹

Type: ICredentialProviderConfig[] (optional, default: [GatewayCredentialProvider.fromIamRole()])

Credential providers for authentication Lambda targets only support IAM role authentication.

description?🔹

Type: string (optional, default: No description)

Optional description for the gateway target The description can have up to 200 characters.

← PreviousNext →