@aws-cdk/aws-bedrock-agentcore-alpha.AddLambdaTargetOptions

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.

Source

lib/gateway/gateway.ts

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 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',
};

Properties

credentialProviderConfigurations?optionalICredentialProviderConfig[]credential_provider_configurations?optionaltyping.List[ICredentialProviderConfig]credentialProviderConfigurations?optionalList<ICredentialProviderConfig>CredentialProviderConfigurations?optionalICredentialProviderConfig[]CredentialProviderConfigurations?optional*[]ICredentialProviderConfig#

Credential providers for authentication.

Default: [GatewayCredentialProvider.iamRole()]

description?optionalstringdescription?optionalstrdescription?optionalStringDescription?optionalstringDescription?optional*string#

Optional description for the gateway target.

Default: No description

gatewayTargetName?optionalstringgateway_target_name?optionalstrgatewayTargetName?optionalStringGatewayTargetName?optionalstringGatewayTargetName?optional*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.