AWS CDK Reference

Appearance

v2.275.0

OrchestrationAIAgentConfigurationProperty 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 orchestrationAIAgentConfigurationProperty: wisdom.CfnAIAgent.OrchestrationAIAgentConfigurationProperty = {
  orchestrationAiPromptId: 'orchestrationAiPromptId',

  // the properties below are optional
  connectInstanceArn: 'connectInstanceArn',
  locale: 'locale',
  orchestrationAiGuardrailId: 'orchestrationAiGuardrailId',
  toolConfigurations: [{
    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 ​

connectInstanceArnoptionalstringconnect_instance_arnoptionalstrconnectInstanceArnoptionalStringConnectInstanceArnoptionalstringConnectInstanceArnoptional*string#
localeoptionalstringlocaleoptionalstrlocaleoptionalStringLocaleoptionalstringLocaleoptional*string#
orchestrationAiGuardrailIdoptionalstringorchestration_ai_guardrail_idoptionalstrorchestrationAiGuardrailIdoptionalStringOrchestrationAiGuardrailIdoptionalstringOrchestrationAiGuardrailIdoptional*string#
orchestrationAiPromptIdstringorchestration_ai_prompt_idstrorchestrationAiPromptIdStringOrchestrationAiPromptIdstringOrchestrationAiPromptId*stringrequired#
toolConfigurationsoptionalIResolvable | IResolvable | CfnAIAgent.ToolConfigurationProperty[]tool_configurationsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ToolConfigurationProperty]]]toolConfigurationsoptionalIResolvableToolConfigurationsoptionalIResolvableToolConfigurationsoptionalinterface{}#