AWS::BedrockAgentCore::GatewayTarget ApiGatewayToolOverride - AWS CloudFormation
SyntaxProperties

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

AWS::BedrockAgentCore::GatewayTarget ApiGatewayToolOverride

Settings to override configurations for a tool.

Syntax

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

JSON

{
  "Description" : String,
  "Method" : String,
  "Name" : String,
  "Path" : String
}

YAML

  Description: String
  Method: String
  Name: String
  Path: String

Properties

Description

The description of the tool. Provides information about the purpose and usage of the tool. If not provided, uses the description from the API's OpenAPI specification.

Required: No

Type: String

Update requires: No interruption

Method

The HTTP method to expose for the specified path.

Required: Yes

Type: String

Allowed values: GET | DELETE | HEAD | OPTIONS | PATCH | PUT | POST

Update requires: No interruption

Name

The name of tool. Identifies the tool in the Model Context Protocol.

Required: Yes

Type: String

Update requires: No interruption

Path

Resource path in the REST API (e.g., /pets). Must explicitly match an existing path in the REST API.

Required: Yes

Type: String

Update requires: No interruption