Skip to content
v2.277.0

Experimental

@aws-cdk/aws-bedrock-agentcore-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

AddLambdaTargetOptions Struct ​

Options for adding a Lambda target to a gateway.

Example ​

ts
// 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 toolSchema: bedrock_agentcore_alpha.ToolSchema;
const addLambdaTargetOptions: bedrock_agentcore_alpha.AddLambdaTargetOptions = {
  lambdaFunction: function_,
  toolSchema: toolSchema,

  // the properties below are optional
  credentialProviderConfigurations: [credentialProviderConfig],
  description: 'description',
  gatewayTargetName: 'gatewayTargetName',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_bedrock_agentcore_alpha as bedrock_agentcore_alpha
from aws_cdk import aws_lambda as lambda_

# credential_provider_config: bedrock_agentcore_alpha.ICredentialProviderConfig
# function_: lambda.Function
# tool_schema: bedrock_agentcore_alpha.ToolSchema

add_lambda_target_options = bedrock_agentcore_alpha.AddLambdaTargetOptions(
    lambda_function=function_,
    tool_schema=tool_schema,

    # the properties below are optional
    credential_provider_configurations=[credential_provider_config],
    description="description",
    gateway_target_name="gatewayTargetName"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.bedrock.agentcore.alpha.*;
import software.amazon.awscdk.services.lambda.*;

ICredentialProviderConfig credentialProviderConfig;
Function function_;
ToolSchema toolSchema;

AddLambdaTargetOptions addLambdaTargetOptions = AddLambdaTargetOptions.builder()
        .lambdaFunction(function_)
        .toolSchema(toolSchema)

        // the properties below are optional
        .credentialProviderConfigurations(List.of(credentialProviderConfig))
        .description("description")
        .gatewayTargetName("gatewayTargetName")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Bedrock.Agentcore.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Bedrock.Agentcore.Alpha;
using Amazon.CDK.AWS.Lambda;

ICredentialProviderConfig credentialProviderConfig;
Function function_;
ToolSchema toolSchema;

var addLambdaTargetOptions = new AddLambdaTargetOptions {
    LambdaFunction = function_,
    ToolSchema = toolSchema,

    // the properties below are optional
    CredentialProviderConfigurations = new [] { credentialProviderConfig },
    Description = "description",
    GatewayTargetName = "gatewayTargetName"
};
go
// Install: go get github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import bedrock_agentcore_alpha "github.com/aws/aws-cdk-go/awsbedrockagentcorealpha"
import "github.com/aws/aws-cdk-go/awscdk"

var credentialProviderConfig ICredentialProviderConfig
var function_ Function
var toolSchema ToolSchema

addLambdaTargetOptions := &AddLambdaTargetOptions{
	LambdaFunction: function_,
	ToolSchema: toolSchema,

	// the properties below are optional
	CredentialProviderConfigurations: []ICredentialProviderConfig{
		credentialProviderConfig,
	},
	Description: jsii.String("description"),
	GatewayTargetName: jsii.String("gatewayTargetName"),
}

Properties ​

credentialProviderConfigurationsoptionalICredentialProviderConfig[]credential_provider_configurationsoptionaltyping.List[ICredentialProviderConfig]credentialProviderConfigurationsoptionalList<ICredentialProviderConfig>CredentialProviderConfigurationsoptionalICredentialProviderConfig[]CredentialProviderConfigurationsoptional*[]ICredentialProviderConfig#
Credential providers for authentication.

Default: [GatewayCredentialProvider.iamRole()]

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
Optional description for the gateway target.

Default: No description

gatewayTargetNameoptionalstringgateway_target_nameoptionalstrgatewayTargetNameoptionalStringGatewayTargetNameoptionalstringGatewayTargetNameoptional*string#
The name of the gateway target Valid characters are a-z, A-Z, 0-9, _ (underscore) and - (hyphen).

Default: auto generate

lambdaFunctionIFunctionlambda_functionIFunctionlambdaFunctionIFunctionLambdaFunctionIFunctionLambdaFunctionIFunctionrequired#
The Lambda function to associate with this target.
toolSchemaToolSchematool_schemaToolSchematoolSchemaToolSchemaToolSchemaToolSchemaToolSchemaToolSchemarequired#
The tool schema defining the available tools.