AWS::BedrockAgentCore::GatewayTarget ApiGatewayToolFilter - 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 ApiGatewayToolFilter

Specifies which operations from an API Gateway REST API are exposed as tools. Tool names and descriptions are derived from the operationId and description fields in the API's exported OpenAPI specification.

Syntax

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

JSON

{
  "FilterPath" : String,
  "Methods" : [ String, ... ]
}

YAML

  FilterPath: String
  Methods: 
    - String

Properties

FilterPath

Resource path to match in the REST API. Supports exact paths (for example, /pets) or wildcard paths (for example, /pets/* to match all paths under /pets). Must match existing paths in the REST API.

Required: Yes

Type: String

Update requires: No interruption

Methods

The methods to filter for.

Required: Yes

Type: Array of String

Update requires: No interruption