AWS CDK

2.239.0

interface ToolConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Wisdom.CfnAIAgent.ToolConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awswisdom#CfnAIAgent_ToolConfigurationProperty`
Java	`software.amazon.awscdk.services.wisdom.CfnAIAgent.ToolConfigurationProperty`
Python	`aws_cdk.aws_wisdom.CfnAIAgent.ToolConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_wisdom` » `CfnAIAgent` » `ToolConfigurationProperty`

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html

Example

// 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

Name	Type	Description
toolName	`string`
toolType	`string`
annotations?	`any`
description?	`string`
inputSchema?	`any`
instruction?	`IResolvable` `\|` `ToolInstructionProperty`
outputFilters?	`IResolvable` `\| (IResolvable` `\|` `ToolOutputFilterProperty)[]`
outputSchema?	`any`
overrideInputValues?	`IResolvable` `\| (IResolvable` `\|` `ToolOverrideInputValueProperty)[]`
title?	`string`
toolId?	`string`
userInteractionConfiguration?	`IResolvable` `\|` `UserInteractionConfigurationProperty`

toolName

Type: string

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html#cfn-wisdom-aiagent-toolconfiguration-toolname

toolType

Type: string

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html#cfn-wisdom-aiagent-toolconfiguration-tooltype

annotations?

Type: any (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html#cfn-wisdom-aiagent-toolconfiguration-annotations

description?

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html#cfn-wisdom-aiagent-toolconfiguration-description

inputSchema?

Type: any (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html#cfn-wisdom-aiagent-toolconfiguration-inputschema

instruction?

Type: IResolvable | ToolInstructionProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html#cfn-wisdom-aiagent-toolconfiguration-instruction

outputFilters?

Type: IResolvable | (IResolvable | ToolOutputFilterProperty)[] (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html#cfn-wisdom-aiagent-toolconfiguration-outputfilters

outputSchema?

Type: any (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html#cfn-wisdom-aiagent-toolconfiguration-outputschema

overrideInputValues?

Type: IResolvable | (IResolvable | ToolOverrideInputValueProperty)[] (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html#cfn-wisdom-aiagent-toolconfiguration-overrideinputvalues

title?

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html#cfn-wisdom-aiagent-toolconfiguration-title

toolId?

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html#cfn-wisdom-aiagent-toolconfiguration-toolid

userInteractionConfiguration?

Type: IResolvable | UserInteractionConfigurationProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiagent-toolconfiguration.html#cfn-wisdom-aiagent-toolconfiguration-userinteractionconfiguration

← Previous Next →