View a markdown version of this page

AWS::BedrockAgentCore::GatewayTarget ConnectorConfiguration - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::BedrockAgentCore::GatewayTarget ConnectorConfiguration

Configuration for a single tool within a connector.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Description" : String,
  "Name" : String,
  "ParameterOverrides" : [ ConnectorParameterOverride, ... ],
  "ParameterValues" : Json
}

Properties

Description

An agent-facing description override for this tool.

Required: No

Type: String

Maximum: 2000

Update requires: No interruption

Name

The tool or operation name (for example, retrieve or webSearch).

Required: Yes

Type: String

Pattern: ^[a-zA-Z][a-zA-Z0-9_-]*$

Maximum: 64

Update requires: No interruption

ParameterOverrides

Parameters to expose to the agent at runtime, with optional description overrides.

Required: No

Type: Array of ConnectorParameterOverride

Update requires: No interruption

ParameterValues

Parameters to set as fixed or default values when provisioning this tool.

Required: No

Type: Json

Update requires: No interruption