interface GatewayTargetLambdaProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.GatewayTargetLambdaProps |
 Go | github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#GatewayTargetLambdaProps |
 Java | software.amazon.awscdk.services.bedrock.agentcore.alpha.GatewayTargetLambdaProps |
 Python | aws_cdk.aws_bedrock_agentcore_alpha.GatewayTargetLambdaProps |
 TypeScript (source) | @aws-cdk/aws-bedrock-agentcore-alpha » GatewayTargetLambdaProps |
Implements
Gateway
Properties for creating a Lambda-based Gateway Target Convenience interface for the most common use case.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_agentcore_alpha from '@aws-cdk/aws-bedrock-agentcore-alpha';
import { aws_lambda as lambda } from 'aws-cdk-lib';
declare const credentialProviderConfig: bedrock_agentcore_alpha.ICredentialProviderConfig;
declare const function_: lambda.Function;
declare const gateway: bedrock_agentcore_alpha.Gateway;
declare const toolSchema: bedrock_agentcore_alpha.ToolSchema;
const gatewayTargetLambdaProps: bedrock_agentcore_alpha.GatewayTargetLambdaProps = {
gateway: gateway,
lambdaFunction: function_,
toolSchema: toolSchema,
// the properties below are optional
credentialProviderConfigurations: [credentialProviderConfig],
description: 'description',
gatewayTargetName: 'gatewayTargetName',
};
Properties
| Name | Type | Description |
|---|---|---|
| gateway | IGateway | The gateway this target belongs to. |
| lambda | IFunction | The Lambda function to associate with this target. |
| tool | Tool | The tool schema defining the available tools. |
| credential | ICredential[] | Credential providers for authentication Lambda targets only support IAM role authentication. |
| description? | string | Optional description for the gateway target The description can have up to 200 characters. |
| gateway | string | The name of the gateway target The name must be unique within the gateway Pattern: ^([0-9a-zA-Z][-]?){1,100}$. |
gateway
Type:
IGateway
The gateway this target belongs to.
lambdaFunction
Type:
IFunction
The Lambda function to associate with this target.
toolSchema
Type:
Tool
The tool schema defining the available tools.
credentialProviderConfigurations?
Type:
ICredential[]
(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.
gatewayTargetName?
Type:
string
(optional, default: auto generate)
The name of the gateway target The name must be unique within the gateway Pattern: ^([0-9a-zA-Z][-]?){1,100}$.