2.233.0

interface ToolDefinitionProperty

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.BedrockAgentCore.Mixins.CfnGatewayTargetPropsMixin.ToolDefinitionProperty
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsbedrockagentcore/mixins#CfnGatewayTargetPropsMixin_ToolDefinitionProperty
Javasoftware.amazon.awscdk.mixins.preview.services.bedrockagentcore.mixins.CfnGatewayTargetPropsMixin.ToolDefinitionProperty
Pythonaws_cdk.mixins_preview.aws_bedrockagentcore.mixins.CfnGatewayTargetPropsMixin.ToolDefinitionProperty
TypeScript @aws-cdk/mixins-preview » aws_bedrockagentcore » mixins » CfnGatewayTargetPropsMixin » 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 { mixins as bedrockagentcore_mixins } from '@aws-cdk/mixins-preview/aws-bedrockagentcore';

declare const schemaDefinitionProperty_: bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.SchemaDefinitionProperty;
const toolDefinitionProperty: bedrockagentcore_mixins.CfnGatewayTargetPropsMixin.ToolDefinitionProperty = {
  description: 'description',
  inputSchema: {
    description: 'description',
    items: schemaDefinitionProperty_,
    properties: {
      propertiesKey: schemaDefinitionProperty_,
    },
    required: ['required'],
    type: 'type',
  },
  name: 'name',
  outputSchema: {
    description: 'description',
    items: schemaDefinitionProperty_,
    properties: {
      propertiesKey: schemaDefinitionProperty_,
    },
    required: ['required'],
    type: 'type',
  },
};

Properties

NameTypeDescription
description?string
inputSchema?IResolvable | SchemaDefinitionPropertyThe input schema for the gateway target.
name?stringThe tool name.
outputSchema?IResolvable | SchemaDefinitionPropertyThe tool definition output schema for the gateway target.

description?

Type: string (optional)

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 (optional)

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 (optional)

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

← PreviousNext →