interface ApiGatewayToolConfiguration 🔹

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

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

const gateway = new agentcore.Gateway(this, "MyGateway", {
  gatewayName: "my-gateway",
});

const api = new apigateway.RestApi(this, 'MyApi', {
  restApiName: 'my-api',
});

// Uses IAM authorization for outbound auth by default
const apiGatewayTarget = gateway.addApiGatewayTarget("MyApiGatewayTarget", {
  restApi: api,
  apiGatewayToolConfiguration: {
    toolFilters: [
      {
        filterPath: "/pets/*",
        methods: [agentcore.ApiGatewayHttpMethod.GET],
      },
    ],
  },
});

Properties

Name	Type	Description
toolFilters🔹	ApiGatewayToolFilter[]	List of tool filters to select operations At least one filter is required.
toolOverrides?🔹	ApiGatewayToolOverride[]	Optional list of tool overrides to customize tool metadata Each override must correspond to an operation selected by the filters.

---

toolFilters🔹

Type: ApiGatewayToolFilter[]

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

---

toolOverrides?🔹

Type: ApiGatewayToolOverride[] (optional, default: No tool overrides)

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