interface ToolDefinitionProperty

Language	Type name
.NET	Amazon.CDK.aws_bedrockagentcore.CfnGatewayTarget.ToolDefinitionProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbedrockagentcore#CfnGatewayTarget_ToolDefinitionProperty
Java	software.amazon.awscdk.services.bedrockagentcore.CfnGatewayTarget.ToolDefinitionProperty
Python	aws_cdk.aws_bedrockagentcore.CfnGatewayTarget.ToolDefinitionProperty
TypeScript	aws-cdk-lib » aws_bedrockagentcore » CfnGatewayTarget » ToolDefinitionProperty

The tool definition for the gateway.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html

Example

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

declare const schemaDefinitionProperty_: bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty;
const toolDefinitionProperty: bedrockagentcore.CfnGatewayTarget.ToolDefinitionProperty = {
  description: 'description',
  inputSchema: {
    type: 'type',

    // the properties below are optional
    description: 'description',
    items: schemaDefinitionProperty_,
    properties: {
      propertiesKey: schemaDefinitionProperty_,
    },
    required: ['required'],
  },
  name: 'name',

  // the properties below are optional
  outputSchema: {
    type: 'type',

    // the properties below are optional
    description: 'description',
    items: schemaDefinitionProperty_,
    properties: {
      propertiesKey: schemaDefinitionProperty_,
    },
    required: ['required'],
  },
};

Properties

Name	Type	Description
description	string
inputSchema	IResolvable | SchemaDefinitionProperty	The input schema for the gateway target.
name	string	The tool name.
outputSchema?	IResolvable | SchemaDefinitionProperty	The tool definition output schema for the gateway target.

---

description

Type: string

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html#cfn-bedrockagentcore-gatewaytarget-tooldefinition-description

---

inputSchema

Type: IResolvable | SchemaDefinitionProperty

The input schema for the gateway target.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html#cfn-bedrockagentcore-gatewaytarget-tooldefinition-inputschema

---

name

Type: string

The tool name.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html#cfn-bedrockagentcore-gatewaytarget-tooldefinition-name

---

outputSchema?

Type: IResolvable | SchemaDefinitionProperty (optional)

The tool definition output schema for the gateway target.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-tooldefinition.html#cfn-bedrockagentcore-gatewaytarget-tooldefinition-outputschema