aws-cdk-lib.aws_bedrockagentcore.CfnGatewayTarget.ToolDefinitionProperty

ToolDefinitionProperty Struct

The tool definition for the gateway.

Source

Generated code

Type last changed

v2.220.0 · 14 Oct 2025

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

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*stringrequired#

inputSchemaIResolvable | CfnGatewayTarget.SchemaDefinitionPropertyinput_schematyping.Union[IResolvable, SchemaDefinitionProperty]inputSchemaIResolvableInputSchemaIResolvableInputSchemainterface{}required#

The input schema for the gateway target.

namestringnamestrnameStringNamestringName*stringrequired#

The tool name.

outputSchema?optionalIResolvable | CfnGatewayTarget.SchemaDefinitionPropertyoutput_schema?optionaltyping.Union[IResolvable, SchemaDefinitionProperty]outputSchema?optionalIResolvableOutputSchema?optionalIResolvableOutputSchema?optionalinterface{}#

The tool definition output schema for the gateway target.