interface ApiGatewayToolOverride 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.ApiGatewayToolOverride
Go	github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#ApiGatewayToolOverride
Java	software.amazon.awscdk.services.bedrock.agentcore.alpha.ApiGatewayToolOverride
Python	aws_cdk.aws_bedrock_agentcore_alpha.ApiGatewayToolOverride
TypeScript (source)	@aws-cdk/aws-bedrock-agentcore-alpha » ApiGatewayToolOverride

Configuration for overriding API Gateway tool metadata.

Tool overrides allow you to customize the tool name or description for specific operations after filtering. Each override must specify an explicit path and a single HTTP method. The override must match an operation that exists in your API and must correspond to one of the operations resolved by your filters.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_agentcore_alpha from '@aws-cdk/aws-bedrock-agentcore-alpha';
const apiGatewayToolOverride: bedrock_agentcore_alpha.ApiGatewayToolOverride = {
  method: bedrock_agentcore_alpha.ApiGatewayHttpMethod.GET,
  name: 'name',
  path: 'path',

  // the properties below are optional
  description: 'description',
};

Properties

Name	Type	Description
method🔹	ApiGatewayHttpMethod	The HTTP method for this override Must be a single method (no wildcards).
name🔹	string	The custom tool name If not provided, the operationId from the OpenAPI definition will be used.
path🔹	string	The explicit resource path (no wildcards) Must match an operation that exists in your API.
description?🔹	string	Optional custom description for the tool.

---

method🔹

Type: ApiGatewayHttpMethod

The HTTP method for this override Must be a single method (no wildcards).

---

name🔹

Type: string

The custom tool name If not provided, the operationId from the OpenAPI definition will be used.

---

path🔹

Type: string

The explicit resource path (no wildcards) Must match an operation that exists in your API.

---

description?🔹

Type: string (optional, default: No custom description)

Optional custom description for the tool.