Package software.amazon.awscdk.services.bedrockagentcore

Interface ApiGatewayToolConfiguration

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ApiGatewayToolConfiguration.Jsii$Proxy

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

Configuration for API Gateway tools.

The API Gateway tool configuration defines which operations from your REST API are exposed as tools. It requires a list of tool filters to select operations to expose, and optionally accepts tool overrides to customize tool metadata.

Example:

 Gateway gateway = Gateway.Builder.create(this, "MyGateway")
         .gatewayName("my-gateway")
         .build();
 RestApi api = RestApi.Builder.create(this, "MyApi")
         .restApiName("my-api")
         .build();
 // Uses IAM authorization for outbound auth by default
 GatewayTarget apiGatewayTarget = gateway.addApiGatewayTarget("MyApiGatewayTarget", AddApiGatewayTargetOptions.builder()
         .restApi(api)
         .apiGatewayToolConfiguration(ApiGatewayToolConfiguration.builder()
                 .toolFilters(List.of(ApiGatewayToolFilter.builder()
                         .filterPath("/pets/*")
                         .methods(List.of(ApiGatewayHttpMethod.GET))
                         .build()))
                 .build())
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ApiGatewayToolConfiguration.Builder	builder()
List<ApiGatewayToolFilter>	getToolFilters()	List of tool filters to select operations At least one filter is required.
default List<ApiGatewayToolOverride>	getToolOverrides()	Optional list of tool overrides to customize tool metadata Each override must correspond to an operation selected by the filters.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getToolFilters

@Stability(Stable)
@NotNull
List<ApiGatewayToolFilter> getToolFilters()

List of tool filters to select operations At least one filter is required.

getToolOverrides

@Stability(Stable)
@Nullable
default List<ApiGatewayToolOverride> getToolOverrides()

Optional list of tool overrides to customize tool metadata Each override must correspond to an operation selected by the filters.

Default: - No tool overrides

builder

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

Returns:

a ApiGatewayToolConfiguration.Builder of ApiGatewayToolConfiguration