interface ToolProperty

Language	Type name
.NET	`Amazon.CDK.aws_bedrock.CfnPromptVersion.ToolProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsbedrock#CfnPromptVersion_ToolProperty`
Java	`software.amazon.awscdk.services.bedrock.CfnPromptVersion.ToolProperty`
Python	`aws_cdk.aws_bedrock.CfnPromptVersion.ToolProperty`
TypeScript	`aws-cdk-lib` » `aws_bedrock` » `CfnPromptVersion` » `ToolProperty`

Information about a tool that you can use with the Converse API.

For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrock as bedrock } from 'aws-cdk-lib';

declare const json: any;
const toolProperty: bedrock.CfnPromptVersion.ToolProperty = {
  cachePoint: {
    type: 'type',
  },
  toolSpec: {
    inputSchema: {
      json: json,
    },
    name: 'name',

    // the properties below are optional
    description: 'description',
  },
};

Properties

Name	Type	Description
cachePoint?	`IResolvable` `\|` `CachePointBlockProperty`	CachePoint to include in the tool configuration.
toolSpec?	`IResolvable` `\|` `ToolSpecificationProperty`	The specfication for the tool.

cachePoint?

Type: IResolvable | CachePointBlockProperty (optional)

CachePoint to include in the tool configuration.

toolSpec?

Type: IResolvable | ToolSpecificationProperty (optional)

The specfication for the tool.