AWS CDK Reference

Appearance

v2.275.0

ToolConfigurationProperty Struct ​

Source
Generated code
Type last changed
v2.235.0 · 15 Jan 2026

Example ​

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

declare const annotations: any;
declare const inputSchema: any;
declare const outputSchema: any;
const toolConfigurationProperty: wisdom.CfnAIAgent.ToolConfigurationProperty = {
  toolName: 'toolName',
  toolType: 'toolType',

  // the properties below are optional
  annotations: annotations,
  description: 'description',
  inputSchema: inputSchema,
  instruction: {
    examples: ['examples'],
    instruction: 'instruction',
  },
  outputFilters: [{
    jsonPath: 'jsonPath',

    // the properties below are optional
    outputConfiguration: {
      outputVariableNameOverride: 'outputVariableNameOverride',
      sessionDataNamespace: 'sessionDataNamespace',
    },
  }],
  outputSchema: outputSchema,
  overrideInputValues: [{
    jsonPath: 'jsonPath',
    value: {
      constant: {
        type: 'type',
        value: 'value',
      },
    },
  }],
  title: 'title',
  toolId: 'toolId',
  userInteractionConfiguration: {
    isUserConfirmationRequired: false,
  },
};

Properties ​

annotationsoptionalanyannotationsoptionalAnyannotationsoptionalObjectAnnotationsoptionalobjectAnnotationsoptionalinterface{}#
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
inputSchemaoptionalanyinput_schemaoptionalAnyinputSchemaoptionalObjectInputSchemaoptionalobjectInputSchemaoptionalinterface{}#
instructionoptionalIResolvable | CfnAIAgent.ToolInstructionPropertyinstructionoptionaltyping.Union[IResolvable, ToolInstructionProperty]instructionoptionalIResolvableInstructionoptionalIResolvableInstructionoptionalinterface{}#
outputFiltersoptionalIResolvable | IResolvable | CfnAIAgent.ToolOutputFilterProperty[]output_filtersoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ToolOutputFilterProperty]]]outputFiltersoptionalIResolvableOutputFiltersoptionalIResolvableOutputFiltersoptionalinterface{}#
outputSchemaoptionalanyoutput_schemaoptionalAnyoutputSchemaoptionalObjectOutputSchemaoptionalobjectOutputSchemaoptionalinterface{}#
overrideInputValuesoptionalIResolvable | IResolvable | CfnAIAgent.ToolOverrideInputValueProperty[]override_input_valuesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ToolOverrideInputValueProperty]]]overrideInputValuesoptionalIResolvableOverrideInputValuesoptionalIResolvableOverrideInputValuesoptionalinterface{}#
titleoptionalstringtitleoptionalstrtitleoptionalStringTitleoptionalstringTitleoptional*string#
toolIdoptionalstringtool_idoptionalstrtoolIdoptionalStringToolIdoptionalstringToolIdoptional*string#
toolNamestringtool_namestrtoolNameStringToolNamestringToolName*stringrequired#
toolTypestringtool_typestrtoolTypeStringToolTypestringToolType*stringrequired#
userInteractionConfigurationoptionalIResolvable | CfnAIAgent.UserInteractionConfigurationPropertyuser_interaction_configurationoptionaltyping.Union[IResolvable, UserInteractionConfigurationProperty]userInteractionConfigurationoptionalIResolvableUserInteractionConfigurationoptionalIResolvableUserInteractionConfigurationoptionalinterface{}#