Package software.amazon.awscdk.services.bedrockagentcore

Interface ApiGatewayToolOverride

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ApiGatewayToolOverride.Jsii$Proxy

@Generated(value="jsii-pacmak/1.129.0 (build eaca441)",
           date="2026-05-19T08:18:44.216Z")
@Stability(Stable)
public interface ApiGatewayToolOverride
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.bedrockagentcore.*;
 ApiGatewayHttpMethod apiGatewayHttpMethod;
 ApiGatewayToolOverride apiGatewayToolOverride = ApiGatewayToolOverride.builder()
         .method(apiGatewayHttpMethod)
         .name("name")
         .path("path")
         // the properties below are optional
         .description("description")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ApiGatewayToolOverride.Builder	A builder for ApiGatewayToolOverride
static final class	ApiGatewayToolOverride.Jsii$Proxy	An implementation for ApiGatewayToolOverride

Method Summary

Modifier and Type	Method	Description
static ApiGatewayToolOverride.Builder	builder()
default String	getDescription()	Optional custom description for the tool.
ApiGatewayHttpMethod	getMethod()	The HTTP method for this override Must be a single method (no wildcards).
String	getName()	The custom tool name If not provided, the operationId from the OpenAPI definition will be used.
String	getPath()	The explicit resource path (no wildcards) Must match an operation that exists in your API.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMethod

@Stability(Stable)
@NotNull
ApiGatewayHttpMethod getMethod()

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

getName

@Stability(Stable)
@NotNull
String getName()

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

getPath

@Stability(Stable)
@NotNull
String getPath()

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

Optional custom description for the tool.

Default: - No custom description

builder

@Stability(Stable)
static ApiGatewayToolOverride.Builder builder()

Returns:

a ApiGatewayToolOverride.Builder of ApiGatewayToolOverride